You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
The text was updated successfully, but these errors were encountered:
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.
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 forknbsphinx
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
indocs/requirements.txt
, will try tagging my commits and using e.g.git+https://github.com/lukelbd/sphinxcontrib-automodapi@v0.5
.The text was updated successfully, but these errors were encountered: