Commit Graph

112 Commits

Author SHA1 Message Date
5a67c4d704 add check for another kind of broken references in ReST files 2024-01-20 10:53:41 -05:00
ed4ae0a26c find more misformatted references in ReST sources 2023-10-26 04:46:33 -04:00
7f934e3b25 add check for broken doc links to doc makefile 2023-03-04 17:09:17 -05:00
b314f73ef4 update .gitignore and fix typo in doc makefile 2023-02-23 00:40:07 -05:00
dfc9da8020 add link_check target calling linkchecker to manual build makefile 2023-02-19 21:12:22 -05:00
d5a8674c00 avoid creating __pycache__ folders outside of the docenv tree 2023-01-21 05:02:09 -05:00
bacb43ea59 add check to detect incorrectly used role keywords. 2022-12-15 16:27:00 -05:00
165b6b4ba3 add workaround for missing links to fortran functions in sphinx output 2022-10-21 18:55:16 -04:00
b5cd834c8f small sphinx tweaks. require sphinx 5.2 or later. 2022-10-21 18:37:16 -04:00
daec261fa1 use $(PIP_OPTIONS) consistently 2022-07-30 17:26:46 -04:00
3f293e1c13 Use pip install -e util/converters in doc build 2022-07-29 17:56:01 -06:00
5fca9f4d1f update mathjax version with bugfix release 2022-06-08 17:04:26 -04:00
13fc4f3588 must install wheel package before all other packages 2022-05-19 23:07:12 -04:00
4801fa00f8 update MathJax to latest bugfix release 2022-05-19 22:53:48 -04:00
247c61c93f make portable to ubuntu 2022-04-21 13:01:13 -04:00
a8e5e0e515 use python -m venv instead of virtualenv 2022-04-20 15:49:22 -04:00
42d875a411 add fasthtml target for faster testing of .rst to html translation 2022-04-20 15:02:00 -04:00
59c060cc0e switch to https protocol for cloning MathJax
https://github.blog/2021-09-01-improving-git-protocol-security-github/
2021-11-02 14:14:08 -04:00
1225dda3ad update MathJax to version 3.2.0 2021-06-17 10:57:15 -04:00
0f5a1178fb we don't need txt2rst and txt2html anymore 2021-05-25 22:14:29 -04:00
3f963ce249 update README/docs about generating the manual and accessing it online 2021-05-24 14:33:00 -04:00
f47333bebf Update MathJax to 3.1.4 hotfix version 2021-04-23 16:38:54 -04:00
a2e46c47e3 download only a specific tag/version of MathJax when cloning 2021-04-22 16:20:34 -04:00
e7a37877c0 apply changes to doc Makefile to limit the impact of SNL network config changes 2021-02-16 11:40:25 -05:00
a83fe46860 spelling target needs conf.py 2021-02-01 20:32:19 -05:00
2b44d67128 consistent dependencies for targes in "doc" folder makefile 2021-02-01 18:13:00 -05:00
6ac481409a remove temporary flag for using the new pip resolver which is now the default 2020-12-01 19:04:43 -05:00
9a3f935c9b do not include polyfill.js anymore 2020-10-27 20:17:59 -04:00
60864f021f replace "doc page" with "page" or equivalent 2020-10-07 22:29:26 -04:00
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