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

docs: improve cross-referencing with intersphinx #203

Merged
merged 15 commits into from
Jul 21, 2021
Merged

docs: improve cross-referencing with intersphinx #203

merged 15 commits into from
Jul 21, 2021

Commits on Jul 20, 2021

  1. fix: remove redundant requirements file 

    Not needed since #185
    @redeboer
    redeboer committed Jul 20, 2021
    Configuration menu
    Copy the full SHA
    a230257 View commit details
    Browse the repository at this point in the history

  2. ci: install tox and define config

    @redeboer
    redeboer committed Jul 20, 2021
    Configuration menu
    Copy the full SHA
    67c663e View commit details
    Browse the repository at this point in the history

  3. ci: activate sphinx-build colors

    @redeboer
    redeboer committed Jul 20, 2021
    Configuration menu
    Copy the full SHA
    9f32b62 View commit details
    Browse the repository at this point in the history

  4. ci: install and configure sphinx-autobuild

    @redeboer
    redeboer committed Jul 20, 2021
    Configuration menu
    Copy the full SHA
    c8aeadf View commit details
    Browse the repository at this point in the history

  5. fix: address Sphinx warnings 

    After this, warnings can be treated as errors. Next, intersphinx can be
actived, as suggested in
#202
    @redeboer
    redeboer committed Jul 20, 2021
    Configuration menu
    Copy the full SHA
    2a08828 View commit details
    Browse the repository at this point in the history

  6. ci: treat Sphinx warnings as errors

    @redeboer
    redeboer committed Jul 20, 2021
    Configuration menu
    Copy the full SHA
    0efc4e0 View commit details
    Browse the repository at this point in the history

  7. fix: remove unknown :rc: Sphinx role

    @redeboer
    redeboer committed Jul 20, 2021
    Configuration menu
    Copy the full SHA
    72c5aa9 View commit details
    Browse the repository at this point in the history

  8. docs: activate intersphinx for mpl and python APIs

    @redeboer
    redeboer committed Jul 20, 2021
    Configuration menu
    Copy the full SHA
    f866796 View commit details
    Browse the repository at this point in the history

  9. docs: activate Sphinx nitpicky option

    @redeboer
    redeboer committed Jul 20, 2021
    Configuration menu
    Copy the full SHA
    aafbcb0 View commit details
    Browse the repository at this point in the history

  10. docs: set default role to :py:obj:

    @redeboer
    redeboer committed Jul 20, 2021
    Configuration menu
    Copy the full SHA
    e46bfcd View commit details
    Browse the repository at this point in the history

  11. docs: add more intersphinx links

    @redeboer
    redeboer committed Jul 20, 2021
    Configuration menu
    Copy the full SHA
    80e854a View commit details
    Browse the repository at this point in the history

  12. docs!: extend API with sphinx-apidoc

    @redeboer
    redeboer committed Jul 20, 2021
    Configuration menu
    Copy the full SHA
    911ea15 View commit details
    Browse the repository at this point in the history

Commits on Jul 21, 2021

  1. fix: remove link to API on main page 

    Co-authored-by: Ian Hunt-Isaak <[email protected]>
    @redeboer @ianhi
    redeboer and ianhi authored Jul 21, 2021
    Configuration menu
    Copy the full SHA
    da2f18d View commit details
    Browse the repository at this point in the history

  2. Merge remote-tracking branch 'upstream/master' into intersphinx

    @redeboer
    redeboer committed Jul 21, 2021
    Configuration menu
    Copy the full SHA
    5155319 View commit details
    Browse the repository at this point in the history

  3. [pre-commit.ci] auto fixes from pre-commit.com hooks 

    for more information, see https://pre-commit.ci
    @pre-commit-ci
    pre-commit-ci[bot] committed Jul 21, 2021
    Configuration menu
    Copy the full SHA
    1589939 View commit details
    Browse the repository at this point in the history