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

Register callback to run sphinx-apidoc on every branch/tag? #68

Open
fritz-hh opened this issue Feb 26, 2021 · 4 comments
Open

Register callback to run sphinx-apidoc on every branch/tag? #68

fritz-hh opened this issue Feb 26, 2021 · 4 comments

Comments

@fritz-hh
Copy link

fritz-hh commented Feb 26, 2021

Hi. Thanks for your great work on sphinx-multiversion.
I have a API documentation generated using sphinx-apidoc and sphinx-build.
I would like to generate a versioned api documentation using sphinx-multiversion in a CI environment with Jenkins.
If possible, I would like to avoid committing/pushing the output of sphinx-apidoc onto the respective branch.

My question is the following: is it possible to tell sphinx-multiversion to run sphinx-apidoc after sphinx-multiversion has checked-out the respective branch, so that sphinx-multiversion can use the rst files generated by sphinx-apidoc.
Thanks in advance for your help.

@fritz-hh
Copy link
Author

PR #62 may solve this issue

@dflock
Copy link

dflock commented Apr 25, 2022

You can use this to get this working: https://pypi.org/project/sphinxcontrib-apidoc/ - it automatically runs the configured apidoc stuff on any sphinx build, including each version build.

@joe-agent
Copy link

Can anyone guide me how to use sphinx-multiversion with sphinx-apidoc

Currently I use the commands below with sphinx-apidoc, but I do not know how to link sphinx-multiversion:

sphinx-apidoc -F --implicit-namespaces -P -o ./doc ./<namespace> ./setup.py
./doc/make.bat clean
./doc/make.bat html

@fritz-hh , any advice?

@BurningEnlightenment
Copy link
Member

Duplicate of #45

@BurningEnlightenment BurningEnlightenment marked this as a duplicate of #45 Oct 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants