Commit Graph

68 Commits

Author SHA1 Message Date
Axel Kohlmeyer 34689fed5e
make clean-all should also remove Manual.pdf and Developer.pdf 2020-04-13 23:34:29 -04:00
Axel Kohlmeyer 1688160669
don't need to force version 2.4.4 of sphinx anymore 2020-04-13 22:55:20 -04:00
Axel Kohlmeyer 20edc12821
copy images from figure rst directives as well 2020-04-11 11:53:55 -04:00
Axel Kohlmeyer 592a5fac53
fix bugs in doc makefile 2020-04-05 21:56:55 -04:00
Axel Kohlmeyer 97b11ea746
enforce using sphinx version 2.4.4, install spellchecker with all other sphinx tools 2020-04-05 21:36:06 -04:00
Axel Kohlmeyer a9dad3d46c
test for PDFLaTeX and update README 2020-04-02 14:31:47 -04:00
Axel Kohlmeyer fb9b5c6dd0
remove command copying (the now removed) doc/src/USER into some output folders 2020-03-19 15:55:05 -04:00
Axel Kohlmeyer 8546bb51bf
Layout images so they show up side-by-side in html and pdf and adapt to screen/paper size 2020-03-11 10:18:48 -04:00
Axel Kohlmeyer 3c277409c2
switch parsed-literal to code-block in Howto files where applicable 2020-02-27 12:45:14 -05:00
Axel Kohlmeyer 3563d2f10d
remove references to html-offline and only produce the offline viewable html manual 2020-02-26 16:01:03 -05:00
Axel Kohlmeyer ca650ba43f
add some missing dependencies 2020-02-22 13:49:57 -05:00
Axel Kohlmeyer e8d1288527
added script to check for missing packages in package tables in manual 2020-02-22 11:46:31 -05:00
Axel Kohlmeyer 60cb4416f0
add ability to build an offline viewable html format manual in html-offline 2020-02-22 02:27:18 -05:00
Axel Kohlmeyer 002fff95c6
copy large target image files only once 2020-02-11 11:07:55 +01:00
Axel Kohlmeyer c8034d19c4
fix up remaining computes for embedded math and a few other issues 2020-02-10 16:21:19 -05:00
Axel Kohlmeyer fa4d9ff0d8
remove automatic translation of .txt to .rst and references to txt folder 2020-01-23 16:56:41 -05:00
Axel Kohlmeyer 204fb6f7ed
fix issue with standalone anchor_check 2020-01-22 23:51:53 -05:00
Axel Kohlmeyer 64e72b1cd5
indent consistently with tabs only 2020-01-12 12:34:54 -05:00
Axel Kohlmeyer 26830d09f8
hook style check into makefile 2020-01-11 20:39:58 -05:00
Richard Berger 81e92de838 Fix doc Makefile 2019-11-07 21:47:29 -05:00
Richard Berger 74dade3ccb Change doc folder src -> txt, rst -> src 2019-11-05 15:27:21 -05:00
Richard Berger 12cb19090a Remove txt2html and htmldoc from doc build 2019-11-02 23:07:49 -04:00
Richard Berger aeaa289d1d Merge branch 'master' into docs_to_rst_migration 2019-11-02 22:57:43 -04:00
Axel Kohlmeyer a5db0463ec
list lines in doc source files with non-ASCII characters 2019-09-25 13:36:57 -04:00
Richard Berger ddab4eeb1a Remove SHA1 utility used in doc Makefile 2019-08-22 14:11:32 -06:00
Richard Berger 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
Axel Kohlmeyer 50082c287d
sphinxcontrib-spelling has been updated for Sphinx 2.x. remove enforcing to use old version 2019-05-18 15:41:38 -04:00
Axel Kohlmeyer 30bca9f91e
force loading of Sphinx version 1.7.6 instead of 2.0.0 or later, so the spellchecker keeps working 2019-03-28 16:20:19 -04:00
Axel Kohlmeyer 4e74ccbbbe
restore building developer pdf before manual pdf 2019-03-25 21:18:17 -04:00
Axel Kohlmeyer 88b62fa6bd
add old style PDF build to "make old" target.
this will create the old style Manual.pdf in the old folder and put Developer.pdf there, too.
2019-02-13 12:43:35 -05:00
efetis 7c1fb847f4 Slight tweak to sed in doc/Makefile 2019-02-06 18:00:23 -08:00
efetis 4fe6528ed4 Add support for Sphinx+PDF+MathJax 2019-02-06 17:14:50 -08:00
Axel Kohlmeyer 3ad4c0db35 expose "make spelling" in the doc folder to the documentation 2018-12-11 21:02:52 -05:00
Axel Kohlmeyer 4af7e706d7 correctly compute hash for temporary directory used by manual building 2018-12-03 14:59:43 -05:00
Axel Kohlmeyer 090fc7bc8a remove unused sphinx-images extension from virtualenv setup 2018-11-20 22:14:24 -05:00
Axel Kohlmeyer c0dd187802 make sure all pictures are includes in epub/mobi files 2018-10-21 18:38:46 -04:00
Axel Kohlmeyer 07a499fcc1 improve check for missing styles in lammps.book 2018-10-20 10:01:55 -04:00
Axel Kohlmeyer 8e7ddff6dc reverse order in which pdf files are created.
Creating Developer.pdf first and Manual.pdf later makes
any warnings from the latter step, e.g. about missing
files in doc/src/lammps.book more visible.
2018-09-27 06:15:03 -04:00
Axel Kohlmeyer c0d9d96e09 better help message in make file 2018-08-22 22:24:51 -04:00
Axel Kohlmeyer d5089858bd add support for the conversion of ePUB to MOBI (compatible with Kindle) 2018-08-22 19:17:21 -04:00
Richard Berger 819e47b69e Add output dir and verbose option to txt2rst 2018-07-27 02:30:28 -04:00
Richard Berger e6e026433c Fix clean-all in docs Makefile 2018-07-25 16:49:51 -04:00
Axel Kohlmeyer 56c3a0be29 support virtualenv on machines with python3 where it is called virtualenv-3 2018-05-31 19:03:28 -04:00
Axel Kohlmeyer 1a402d4002 refactor headline levels to result in a more structured PDF manual 2018-03-20 15:42:13 -04:00
Axel Kohlmeyer 69f813b22e fix up formatting of tutorials for PDF manual 2018-02-13 16:41:23 +01:00
Axel Kohlmeyer 63714c7079 remove PDF-only .txt file from Sphinx documentation processing 2018-02-13 13:10:20 +01:00
Axel Kohlmeyer ed8680d695 suspend support for sphinxcontrib.images
the sphinxcontrib.image extension was broken with sphinx 16.x.
however, sphinx 15.x breaks with newer version of the multiprocessor module.
so we suspend the thumbnail processing and lift the lock to sphinx 15.x

also, the number of parallel sphinx tasks is can be overridden with SPHINXEXTRA="-j #'.
default is to try use all local CPU cores.
2017-12-07 15:38:15 -05:00
Richard Berger 9593e05c9e Force PDF documentation build to fail on first error 2017-05-18 19:37:08 -04:00
Axel Kohlmeyer bd11479a16 lock the sphinx command to version 1.5.6, since version 1.6.x seems to break one of the extensions we use 2017-05-18 00:50:35 -04:00
Axel Kohlmeyer 3ec16f3630 fully integrate support for doc_anchor_check into docs makefile 2017-03-22 14:40:30 -04:00