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

Move metadata, versions and specifiers API documentation to sphinx.ext.autodoc #572

Merged
merged 5 commits into from Jul 16, 2022

Commits on Jul 9, 2022

  1. Rework conf.py to match newer Sphinx style

    This is the style of organisation within the conf.py file that is used
    in newer Sphinx versions.
    pradyunsg committed Jul 9, 2022
    Copy the full SHA
    98703d4 View commit details
    Browse the repository at this point in the history
  2. Remove an unused _static directory

    If we need it, we can add it in later.
    pradyunsg committed Jul 9, 2022
    Copy the full SHA
    cce2e7b View commit details
    Browse the repository at this point in the history
  3. Rework the metadata module annotations and documentation

    The migration from modern annotations (thanks to a `__future__` import)
    to the plain typing-import based annotations is to deal with limitations
    of intersphinx with autodoc, which currently can't linkify annotations
    with future style imports.
    
    Similarly, to make the type annotations in the generated documentation
    correctly link to the various "internal" types, they need to be imported
    and referenced by their regular name instead of a changed-name
    import. In the spirit of consistency, all imports were changed to match
    this style.
    
    This allows for eliminating duplication of content in the implementation
    and documentation, reducing the general maintainance overhead of this
    module.
    pradyunsg committed Jul 9, 2022
    Copy the full SHA
    790759c View commit details
    Browse the repository at this point in the history

Commits on Jul 10, 2022

  1. Rework the specifiers documentation

    Moving the content into inline docstrings makes it easier to ensure that
    they are updated/evolve with the implementation.
    
    This also expands the behaviors shown, by documenting the relevant
    details for each function. These examples are doctest'd in CI.
    pradyunsg committed Jul 10, 2022
    Copy the full SHA
    fe5a6f1 View commit details
    Browse the repository at this point in the history
  2. Rework the version documentation

    Moving the content into inline docstrings makes it easier to ensure that
    they are updated/evolve with the implementation.
    
    This also expands the behaviors shown, by documenting the relevant
    details for each function. These examples are doctest'd in CI.
    pradyunsg committed Jul 10, 2022
    Copy the full SHA
    1707d41 View commit details
    Browse the repository at this point in the history