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.

Sign up for GitHub

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

Jump to bottom

Implement documentation linting #1854

Merged
merged 4 commits into from
Apr 10, 2023
Merged

Implement documentation linting #1854

merged 4 commits into from
Apr 10, 2023

Commits on Apr 10, 2023

  1. Implement documentation linting 

    - Introduce new tox environments `docs-lint` and `docs-all`
  - `docs-lint` will check for dead links and run spellchecking
  - `docs-all` will force a rebuild for all documentation
- Update documentation and docstrings to pass linting; this includes
  some innocuous code changes for modernization
- Run `tox -e docs-lint` on RTD before the docs are built
    @rmartin16
    rmartin16 committed Apr 10, 2023
    Configuration menu
    Copy the full SHA
    37b58ec View commit details
    Browse the repository at this point in the history

  2. Condense tox env config for docs

    @rmartin16
    rmartin16 committed Apr 10, 2023
    Configuration menu
    Copy the full SHA
    3b8c18c View commit details
    Browse the repository at this point in the history

  3. Removed code terms from wordlist.

    @freakboy3742
    freakboy3742 committed Apr 10, 2023
    Configuration menu
    Copy the full SHA
    8eafd1c View commit details
    Browse the repository at this point in the history

  4. Corrected some markup on Font.

    @freakboy3742
    freakboy3742 committed Apr 10, 2023
    Configuration menu
    Copy the full SHA
    c4c3abc View commit details
    Browse the repository at this point in the history