Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enable readthedocs build for >= 0.2a #250

Open
eirrgang opened this issue Jan 13, 2020 · 0 comments
Open

Enable readthedocs build for >= 0.2a #250

eirrgang opened this issue Jan 13, 2020 · 0 comments
Assignees
Labels
gmxapi pertains to this repository and the Python module support task Task in support of a larger issue

Comments

@eirrgang
Copy link
Collaborator

Long term solution for documentation builds during GROMACS annual development cycle, during which public web documentation is not provided by GROMACS infrastructure, but during which we would like to provide gmxapi users with the most up-to-date easy-to-access documentation. We could add a conf.py to the gh-pages branch, in which we copy content from the gmxapi/docs Docker image, or we could maintain static content in our fork, as with #249. The solution to this issue might evolve during 2020 to get up-to-date content soonest, and add automation later.

Also, note that the structure of the GROMACS repository might change soon to support gmxapi builds as a primary use case for the repository, with setup.py as a first-class entry point to the GROMACS build system. In that case, regular readthedocs builds will become much simpler and we can use traditional RTD automation approaches.

However, note that we have not enabled the RTD web API hook on the kassonlab org account, so someone still has to go click "build" on the RTD dashboard, at least.

@eirrgang eirrgang added task Task in support of a larger issue gmxapi pertains to this repository and the Python module support labels Jan 13, 2020
@eirrgang eirrgang self-assigned this Jan 13, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
gmxapi pertains to this repository and the Python module support task Task in support of a larger issue
Projects
None yet
Development

No branches or pull requests

1 participant