Project

General

Profile

Feature #2985

Task #2045: API design and language bindings

Task #2698: gmxapi documentation integration

Python package documentation

Added by Eric Irrgang 4 months ago.

Status:
New
Priority:
Normal
Assignee:
-
Category:
documentation
Target version:
Difficulty:
uncategorized
Close

Description

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.


Subtasks

Task #3014: gmxapi example Python scriptsNew

Associated revisions

Revision f29a1758 (diff)
Added by Eric Irrgang 16 days ago

Build gmxapi documentation in main GROMACS documentation.

  • Update gmxapi Python package installation instructions and remove
    quickstart.rst
  • Minor updates to main installation guide document.

Refs #2698
Refs #2985

Change-Id: I6f1d6e6fe59e618144e4f14c0d2fe9f9b8c2c901

Also available in: Atom PDF