Some infrastructure and organizational details need to be worked out to build and publish documentation related to the gmxapi Python package.
For gmxapi <= 0.0.7, the Python package is in a separate repository on GitHub that is automatically downloaded and built by readthedocs. This is a little more complicated to do with the Python package in a subdirectory of the primary GROMACS repository, but we also probably want to integrate the Python package documentation with the rest of the GROMACS documentation.
The Python gmxapi package needs to be built and importable in order for Sphinx to automatically extract docstrings from the C++ bindings module.
This Redmine Issue is currently a stub to catch details of infrastructure, layout, contents, integration, publishing, and automation.
Deduplicate gmxapi documentation.
`docs/gmxapi` seems to have settled down and does not have substantial
layout changes from the documentation in python_packaging/documentation.
Compartmentalized doc builds, e.g. with docs.dockerfile, still warrant
a separate simple conf.py, so that much is retained. Otherwise, it looks
like documentation for the standalone gmxapi package or development can
be maintained in a unified way with the GROMACS project documentation,
so this change removes the transitionally duplicated content.
- Remove most of python_packaging/documentation
- Update python_packaging/docker/docs.dockerfile
Add transitional links for online gmxapi Python package reference.
- Update and clarify pythonreference stub for when Python package was
- Note related Redmine reference.
- Remove `python-procedural` label, which had lost meaning and which
could cause awkward repositioning for the pythonreference stub with
no section heading to follow the label.