Hawkin
/
arangodb
mirror of https://gitee.com/bigwinds/arangodb
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
24,075 Commits 358 Branches 495 Tags 994 MiB
Commit Graph

53 Commits

Author SHA1 Message Date
Wilfried Goesgens aae19ff291 Fix dangling anchors and add checker script to the make target. 2015-11-26 18:51:39 +01:00
Wilfried Goesgens eb75c12bb2 Newer Versions of gitbook put in the source document. Exclude these lines from our sanity checks. 2015-11-03 11:27:59 +01:00
Wilfried Goesgens aa12514b5c Fix links; currently links in REST-documentation only work in the RESTDESCRIPTION :-( 2015-10-01 13:30:55 +02:00
Wilfried Goesgens 17f1b316dd Add checker for MarkdownPP failures; fix existing failures (fixes #1497) 
MarkdownPP fails on broken ``` code sections.
 2015-09-17 17:26:01 +02:00
Wilfried Goesgens b06d03e84f Cleanup documentation for remaining @-tags 2015-09-17 11:15:33 +02:00
Wilfried Goesgens 70a2c74c1b Update RESTAPI documentation handling to work with the swagger 2 api 
- use the structures from the swagger for post / reply structures
  - add missing documentation snippets to their respective places
  - fix syntax of documentation blocks
 2015-09-16 16:35:13 +02:00
CoDEmanX 8aa78dcb7f Fix some more typos 2015-09-05 17:18:04 +02:00
Willi Goesgens 2ba7863592 .md links should be replaced by .html during the processing, if not, they're dangling links. 2015-09-04 09:48:05 +02:00
Willi Goesgens 11a8b1841b Restructure Documentation to reduce the number of top list items 
- combine HTTP-API Bulk interface descriptions and the tools that use them in an new top-level point 'Bulk Import/Export'
  - add information about the arangosh db-object implementation
  - add information about the arangod db-object implementation (fixes #1223)
 2015-09-03 14:44:45 +02:00
Jan Steemann d8c83a02b3 don't include bogus files when checking duplicate documentation blocks 2015-09-03 13:07:14 +02:00
Willi Goesgens 77c97199f2 We need to copy the pngs, else later build steps will only contain possibly invalid symlinks to them. 2015-08-31 14:33:35 +02:00
CoDEmanX 23db2af78a Improvements to documentation building 
Fix sed parameter error that creates additional files on Windows/Cygwin, support Python 2.6, fix font for deprecated summary entries and add author/description to book.
 2015-08-22 04:18:02 +02:00
CoDEmanX 183adccbd9 Make version more prominent in documentation 
Many ebook readers (and reading apps) generate covers from meta data like the book title. Therefore it makes sense to place the version string there instead of the first paragraph.
 2015-08-21 00:18:32 +02:00
Willi Goesgens 6b575c96d9 Add the version into the body of the document, since the header isn't rendered into pdf & ebook. 2015-08-20 14:34:25 +02:00
Willi Goesgens 4797b81f44 fix creation / copying of static files 2015-08-14 14:46:57 +02:00
Willi Goesgens b20b58f62e Enable check-docublocks. 2015-08-13 18:55:17 +02:00
Willi Goesgens 0486ab8017 Fix check-summary target, and re-enable it 2015-08-13 16:12:57 +02:00
Willi Goesgens 080ef2ccf0 Work on the check-docublocks target 
- include more temporary files from processing
 2015-08-13 15:41:32 +02:00
Willi Goesgens c07ede6230 fix installation procedure for included images. 2015-08-11 16:07:34 +02:00
Willi Goesgens 3c988dc7f1 fix parts of the check-docublocks target to work with the new inline samples. 
However, its not yet clean, since its primary conditions still aren't met.
 2015-08-11 14:16:28 +02:00
Willi Goesgens 6fdb550a60 Fix directories & orders 2015-08-06 15:39:19 +02:00
Willi Goesgens 80a43d30a1 Rework documentation generation process 
- remove bot.py, its done now in generateMdFiles.py
  - remove make file target that calls python markdownPP for each file
  - add generateMdFiles.py that now
    - iterates over all files to be processed
    - runs markdownPP as a module for it
    - runs the codeblock replacer
  - sort per book make targets
  - bisect intermediate files into a temporary directory: ppbooks; this simplifies cleaning dramatically.
 2015-08-06 13:20:35 +02:00
Thomas Schmidts 1ae27459f9 Added Version-number to the documentation 2015-08-04 11:42:03 +02:00
Willi Goesgens 9899ddf03c Add recommendations about using date time in collections; fixes #1400 2015-07-03 09:30:14 +02:00
Thomas Schmidts 688f18c612 Added images to a new folder on the arangodb server 2015-06-08 18:31:52 +02:00
Thomas Schmidts f5f0d3ece8 Added new header to the Documentation 2015-06-08 18:06:08 +02:00
Willi Goesgens e2b741b402 Add one more test from the automatic Thomas which searches for leftover markdown in the HTML. 2015-05-26 18:36:01 +02:00
Thomas Schmidts d9d0b57504 Added a Blacklist for files in Summary that can be ignored 2015-05-26 16:18:47 +02:00
Willi Goesgens 5c7fc984cf - Move sanity checks into own target 
- find proper place to hook in check-summary
 2015-05-26 16:10:55 +02:00
Thomas Schmidts a7c9119ec3 Removed duplicate output in the Makefile for the Documentation 2015-05-26 11:40:01 +02:00
Thomas Schmidts 0e57127dc9 Exclude false positive from check for the documentation Makefile 2015-05-26 11:36:47 +02:00
Willi Goesgens b3e707693d polish output of check-summary 2015-05-26 11:17:58 +02:00
Willi Goesgens 81ed50551a Check whether all .md files are found in the summary.md 2015-05-26 11:15:38 +02:00
Willi Goesgens 871a95122c Work on documentation - not all documentation from the code seems to appear in the generated documentation. 2015-05-22 15:37:23 +02:00
Thomas Schmidts b1e2514163 Added new toggle and fixed the search in the docs 2015-05-21 16:05:21 +02:00
Willi Goesgens 0f42ea550e Move the index.html generator from automatic Thomas to the makefile; so linkchecker can properly run after the make cycle. 2015-05-12 14:41:14 +02:00
Jan Steemann 61e1e09be9 make documentation generation run fail when there exist output files with unreplaced @startDocuBlock markers 2015-04-03 12:45:23 +02:00
Thomas Schmidts a871127af5 Changed Makefile for gitbook 2.0.0 2015-03-27 10:01:25 +01:00
Thomas Schmidts 59311fda0f Changed design of the docs and update the themes 2015-03-03 14:25:47 +01:00
Michael Hackstein cfe36890ee Fixed Documentation Makefile, it does not generate a larger folder depth 2015-02-04 09:50:00 +01:00
Patrick Huber d6df865ab8 add clean-books & clean target 2014-12-05 23:07:13 +01:00
Patrick Huber 8005220502 echo not needed, rm can do that 2014-12-05 22:53:20 +01:00
Thomas Schmidts cf17693356 Added style for deprecated documentation 2014-09-11 15:40:20 +02:00
Frank Celler 8632fed0ec added keep-md 2014-06-25 12:15:20 +02:00
Frank Celler 9ec23692ee splitted targets 2014-06-18 19:43:49 +02:00
Thomas Schmidts 01c2770030 Fixed a small bug in the python script 2014-06-18 16:52:35 +02:00
Thomas Schmidts f4e8f439bd Script for reading code automatically 2014-06-18 11:09:20 +02:00
Thomas Schmidts 86cce6f19f Some fixes for folding 2014-06-11 15:25:04 +02:00
Thomas Schmidts 1b3a138fa4 .mds will be deleted after gitbook is made. Also modified search for codeDocuBlock 2014-06-05 12:53:10 +02:00
Michael Hackstein 244fe61e6c Readded tabs in documentation makefile 2014-06-04 16:04:53 +02:00