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

Local sphinx extensions #38

Closed
lukelbd opened this issue Sep 11, 2019 · 1 comment
Closed

Local sphinx extensions #38

lukelbd opened this issue Sep 11, 2019 · 1 comment

Comments

@lukelbd
Copy link
Collaborator

lukelbd commented Sep 11, 2019

Currently, ProPlot documentation is generated with my fork of the "automodapi" astropy extension. The fork is published on PyPi under the name sphinxcontrib-automodapi. This is the only way I could get these forks to work with readthedocs, but it's not ideal -- would rather leave the forks unpublished and tailor its needs to ProPlot. I may also need to fork nbsphinx soon.

In the future, ProPlot will use either (1) local sphinx extensions, or (2) unpublished sphinx extension forks under my username. So instead of the line sphinxcontrib-automodapi>=0.5 in docs/requirements.txt, will try tagging my commits and using e.g. git+https://github.com/lukelbd/sphinxcontrib-automodapi@v0.5.

@lukelbd
Copy link
Collaborator Author

lukelbd commented Sep 14, 2019

Closed by 200112f. Note the module name has been reverted to sphinx-automodapi, published here.

I think implementing custom sphinx extensions by adding github repos to docs/requirements.txt is the best approach. It doesn't clutter the original project, doesn't require git submodules, and doesn't require publishing a separately maintained project, but leaves the option to do so or merge with the original project in the future.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant