Join GitHub today
GitHub is home to over 40 million developers working together to host and review code, manage projects, and build software together.Sign up
Change documentation to use RST directly #1643
Adding the auto-generated RST files to version control is the first step of moving the documentation to RST-only.
@rbberger (Temple University)
By submitting this pull request, I agree, that my contribution will be included in LAMMPS and redistributed under either the GNU General Public License version 2 (GPL v2) or the GNU Lesser General Public License version 2.1 (LGPL v2.1).
HTML docs are now built directly from the RST files that are part of this repo. There is no temporary directory in
The documentation build and its files are directly written into the doc folder. Files that are not supposed to be checked in are in
Post Submission Checklist
Please check the fields below as they are completed after the pull request has been submitted. Delete lines that don't apply
Further Information, Files, and Links
Put any additional information here, attach relevant text or image files, and URLs to external sites (e.g. DOIs or webpages)
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.
@rbberger as discussed in person, I would like to merge this PR next, so that we finally begin the transition to writing documentation directly in RST. We should leave the conversion toolchain around until after the next stable release. but we should already remove the support for the legacy documentation via txt2html and htmldoc. Could you please update this PR to the state of the current master?
@rbberger Glad to see you are making progress on this big, long-term change. I'm finding that in-semester teaching duties are giving me no time to help. But I will have a month, from mid-December to mid-January without day-to-day content and grading duties. If there's anything I can do to help during that interim period, I'd be happy to give it a go. Would still like to find a role to contribute over the long run.