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

Use sphinxcontrib-apidoc extension for readthedocs builds #345

Merged
merged 1 commit into from
Aug 10, 2021
Merged

Use sphinxcontrib-apidoc extension for readthedocs builds #345

merged 1 commit into from
Aug 10, 2021

Conversation

JWCook
Copy link
Contributor

@JWCook JWCook commented Aug 10, 2021

This PR replaces the run_apidoc event handler with the sphinxcontrib-apidoc extension. It does pretty much the same thing, but it's a little more convenient. Feel free to close this PR if you don't find that useful, but personally it's saved me quite a few headaches.

Notes:

  • apidoc_separate_modules is equivalent to the -e option
  • apidoc_module_dir and apidoc_output_dir are relative to the documentation source dir (/docs)
  • I updated tox.ini so local Sphinx builds will use the apidoc config in conf.py instead of separately running the sphinx-apidoc command
  • I added a .readthedocs.yml to install docs-requirements.txt. If you already have that configured in your settings on readthedocs.org, that file can be removed.

.readthedocs.yml Outdated Show resolved Hide resolved
@jparise
Copy link
Collaborator

jparise commented Aug 10, 2021

  • I added a .readthedocs.yml to install docs-requirements.txt. If you already have that configured in your settings on readthedocs.org, that file can be removed.

Yes, we already have this configured on readthedocs.org. I think we don't need the additional configuration file.

@JWCook
Copy link
Contributor Author

JWCook commented Aug 10, 2021

  • I added a .readthedocs.yml to install docs-requirements.txt. If you already have that configured in your settings on readthedocs.org, that file can be removed.

Yes, we already have this configured on readthedocs.org. I think we don't need the additional configuration file.

Okay, I removed it.

Copy link
Collaborator

@jparise jparise left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good. Thanks for the improvement!

@jparise jparise merged commit 0ecdc4c into pinterest:master Aug 10, 2021
@JWCook JWCook deleted the sphinx-apidoc branch August 10, 2021 17:05
@JWCook
Copy link
Contributor Author

JWCook commented Aug 10, 2021

You're very welcome. Thanks for the great library!

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

Successfully merging this pull request may close these issues.

2 participants