2f8a5ddd1f
xindy doesn't seem to be required (and is not available on CentOS 8)
2020-09-23 17:13:09 -04:00
92f8398bed
check more thoroughly for prerequisites to translate the PDF manual. update doc/README
2020-09-19 18:16:52 -04:00
6b0346c299
try use unencrypted download or using wget if normal download of polyfill.js fails
2020-09-19 16:14:08 -04:00
9030c987e6
tweak formatting and style setting to have the desired structure and layout
2020-09-19 00:54:54 -04:00
b520a6287b
Revert parts of "Restore PDF index"
...
We need to update the container image(s) for building the
pdf documentation on ci.lammps.org by adding `latexmk`
and `xindy` before we can re-enable this change to the makefile.
This partially reverts commit 3c3b76a781
2020-09-18 18:37:26 -04:00
3c3b76a781
Restore PDF index
2020-09-18 17:51:51 -04:00
4c5aedeaa0
fix typo
2020-09-17 12:50:53 -04:00
91eaaba1be
improve portability of docs makefile
...
- detect if /bin/bash is not found and provide a suitable error message
- use $(MAKE) and $(MFLAGS) variables to handle cases where GNU make is not called "make"
2020-09-17 12:40:09 -04:00
3d37fd05f4
disable caching - for now - to avoid bad side effects from sphinx-tabs
2020-09-10 16:14:18 -04:00
f8495975d3
transfer the rest of the Developer guide and remove the .tex versions and references to it
2020-08-28 10:52:45 -04:00
c256f2331f
JPG folder is no longer needed in HTML output
2020-08-25 16:59:39 -04:00
df8fb26272
Refactor changes to documentation build
...
- Added CMake variables for readability
- Moved Mathjax files to _static to avoid special copy logic
- Moved JPG/lammps-logo.png to _static to avoid special copy logic
- Removed dead CMake code
2020-08-25 13:41:31 -04:00
3f685c346f
add doxygen integration with conventional and cmake doc build
2020-08-24 17:58:37 -04:00
265b7cf11c
use new dependency resolver in pip for the documentation build virtual environment
2020-08-11 14:11:44 -04:00
437ff2742d
Update lammps_theme (based on latest sphinx_rtd_theme)
2020-07-21 12:44:10 -04:00
34689fed5e
make clean-all should also remove Manual.pdf and Developer.pdf
2020-04-13 23:34:29 -04:00
1688160669
don't need to force version 2.4.4 of sphinx anymore
2020-04-13 22:55:20 -04:00
20edc12821
copy images from figure rst directives as well
2020-04-11 11:53:55 -04:00
592a5fac53
fix bugs in doc makefile
2020-04-05 21:56:55 -04:00
97b11ea746
enforce using sphinx version 2.4.4, install spellchecker with all other sphinx tools
2020-04-05 21:36:06 -04:00
a9dad3d46c
test for PDFLaTeX and update README
2020-04-02 14:31:47 -04:00
fb9b5c6dd0
remove command copying (the now removed) doc/src/USER into some output folders
2020-03-19 15:55:05 -04:00
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
3c277409c2
switch parsed-literal to code-block in Howto files where applicable
2020-02-27 12:45:14 -05:00
3563d2f10d
remove references to html-offline and only produce the offline viewable html manual
2020-02-26 16:01:03 -05:00
ca650ba43f
add some missing dependencies
2020-02-22 13:49:57 -05:00
e8d1288527
added script to check for missing packages in package tables in manual
2020-02-22 11:46:31 -05:00
60cb4416f0
add ability to build an offline viewable html format manual in html-offline
2020-02-22 02:27:18 -05:00
002fff95c6
copy large target image files only once
2020-02-11 11:07:55 +01:00
c8034d19c4
fix up remaining computes for embedded math and a few other issues
2020-02-10 16:21:19 -05:00
fa4d9ff0d8
remove automatic translation of .txt to .rst and references to txt folder
2020-01-23 16:56:41 -05:00
204fb6f7ed
fix issue with standalone anchor_check
2020-01-22 23:51:53 -05:00
64e72b1cd5
indent consistently with tabs only
2020-01-12 12:34:54 -05:00
26830d09f8
hook style check into makefile
2020-01-11 20:39:58 -05:00
81e92de838
Fix doc Makefile
2019-11-07 21:47:29 -05:00
74dade3ccb
Change doc folder src -> txt, rst -> src
2019-11-05 15:27:21 -05:00
12cb19090a
Remove txt2html and htmldoc from doc build
2019-11-02 23:07:49 -04:00
aeaa289d1d
Merge branch 'master' into docs_to_rst_migration
2019-11-02 22:57:43 -04:00
a5db0463ec
list lines in doc source files with non-ASCII characters
2019-09-25 13:36:57 -04:00
ddab4eeb1a
Remove SHA1 utility used in doc Makefile
2019-08-22 14:11:32 -06: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
50082c287d
sphinxcontrib-spelling has been updated for Sphinx 2.x. remove enforcing to use old version
2019-05-18 15:41:38 -04:00
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
4e74ccbbbe
restore building developer pdf before manual pdf
2019-03-25 21:18:17 -04:00
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
7c1fb847f4
Slight tweak to sed in doc/Makefile
2019-02-06 18:00:23 -08:00
4fe6528ed4
Add support for Sphinx+PDF+MathJax
2019-02-06 17:14:50 -08:00
3ad4c0db35
expose "make spelling" in the doc folder to the documentation
2018-12-11 21:02:52 -05:00
4af7e706d7
correctly compute hash for temporary directory used by manual building
2018-12-03 14:59:43 -05:00
090fc7bc8a
remove unused sphinx-images extension from virtualenv setup
2018-11-20 22:14:24 -05:00
