Commit Graph

11 Commits

Author SHA1 Message Date
60cb4416f0 add ability to build an offline viewable html format manual in html-offline 2020-02-22 02:27:18 -05:00
574e4067dc Add documentation files in RST format
This is the first step for moving the documentation format from *.txt to the
*.rst format.

In the last years we've been automatically converting txt files from Steve's
markup into RST to generate the documentation pages via Sphinx. The decision
has now been made to fully migrate to RST and avoid the conversion in the
future.

This will enable us to fully use RST and Sphinx to improve the documentation.

For the intermediate period, while there are still pending PRs with
documentation changes, we will keep both source files and update the RST files
accordingly.
2019-08-22 14:11:32 -06:00
0108855930 update .gitignore for the doc folder 2019-02-14 02:54:02 -05:00
622eb47902 some small tweaks, fixes for typos, and url corrections for the manual 2019-02-07 01:19:29 -05:00
4fe6528ed4 Add support for Sphinx+PDF+MathJax 2019-02-06 17:14:50 -08:00
fc9eebb936 Added spellcheck utility to documentation build
Uses the sphinxcontrib-spelling extension and requires PyEnchant and
aspell-en to be installed.

Adds the optional make target 'spelling' which produces the file
spelling/output.txt. It contains all words it detects.

Due to the large number of false positives, words in
utils/sphinx-config/false_positives.txt are ignored.
2017-03-05 21:23:41 -05:00
607246f923 ignore mobi file as well 2016-10-21 13:25:53 -04:00
ed3f02f249 ignore generated PDF and ePUB files 2016-10-21 12:04:48 -04:00
9bedb8a1c9 ignore generated files in html folder 2016-09-20 18:54:51 -04:00
c80dad0028 new fix flow/gauss command 2016-08-27 16:25:01 -06:00
9be235d872 improved .gitignore files to show only changes in relevant folders and files 2016-08-26 14:34:42 -04:00