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

Fix documentation generation #807

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Conversation

jwhitlock
Copy link

This allow tox -e docs to run without warnings or errors. This was mostly fixing class references in docstrings. A few other changes:

  • Switch license_file to license_files in setup.cfg. This was added to setuptools in v42.0.0 (Nov 2019), and license_file was deprecated in v57.0.0 (May 2021).
  • Fix the envlist for tox. Running tox -e py38-lint would run pytest, not flake8, and tox -e py38-docs would not build docs.

setuptools v42.0.0 (Nov 2019) added license_files, and v57.0.0 (May
2021) deprecated license_file.
Running `tox -e py38-lint` would run pytest, not flake8.
`tox -e docs` runs cleanly:
* Set the default language to 'en'
* Fix class references in doc strings
@JoelLefkowitz JoelLefkowitz added 1.23.x Release target in 1.23.x bug Bug report/fix labels Oct 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
1.23.x Release target in 1.23.x bug Bug report/fix
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants