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

Add contributing section to docs #16

Open
wants to merge 20 commits into
base: main
Choose a base branch
from
Open

Add contributing section to docs #16

wants to merge 20 commits into from

Commits on Oct 21, 2022

  1. add a contributing sections to the docs

    @mcflugen
    mcflugen committed Oct 21, 2022
    Configuration menu
    Copy the full SHA
    b32c596 View commit details
    Browse the repository at this point in the history

  2. add sessions for build and cleaning the docs

    @mcflugen
    mcflugen committed Oct 21, 2022
    Configuration menu
    Copy the full SHA
    7d20ec7 View commit details
    Browse the repository at this point in the history

  3. add a quickstart page to the docs

    @mcflugen
    mcflugen committed Oct 21, 2022
    Configuration menu
    Copy the full SHA
    d4cc77a View commit details
    Browse the repository at this point in the history

  4. add intersphinx mappings for numpy, scipy, xarray, python

    @mcflugen
    mcflugen committed Oct 21, 2022
    Configuration menu
    Copy the full SHA
    ee16aba View commit details
    Browse the repository at this point in the history

  5. remove some lint

    @mcflugen
    mcflugen committed Oct 21, 2022
    Configuration menu
    Copy the full SHA
    ca3b07b View commit details
    Browse the repository at this point in the history

  6. add autobuild and copybutton sphinx extensions

    @mcflugen
    mcflugen committed Oct 21, 2022
    Configuration menu
    Copy the full SHA
    67dc476 View commit details
    Browse the repository at this point in the history

Commits on Oct 22, 2022

  1. add an intro to the API documentation

    @mcflugen
    mcflugen committed Oct 22, 2022
    Configuration menu
    Copy the full SHA
    19bd156 View commit details
    Browse the repository at this point in the history

  2. add additional pre-commit hooks for linting

    @mcflugen
    mcflugen committed Oct 22, 2022
    Configuration menu
    Copy the full SHA
    68480ca View commit details
    Browse the repository at this point in the history

  3. remove extra whitespace

    @mcflugen
    mcflugen committed Oct 22, 2022
    Configuration menu
    Copy the full SHA
    b997836 View commit details
    Browse the repository at this point in the history

  4. add gitignore for sphinx-apidoc generated files

    @mcflugen
    mcflugen committed Oct 22, 2022
    Configuration menu
    Copy the full SHA
    682c9df View commit details
    Browse the repository at this point in the history

  5. remove docstring lint

    @mcflugen
    mcflugen committed Oct 22, 2022
    Configuration menu
    Copy the full SHA
    b7319a1 View commit details
    Browse the repository at this point in the history

  6. remove .DS_Store files when cleaning

    @mcflugen
    mcflugen committed Oct 22, 2022
    Configuration menu
    Copy the full SHA
    5cab338 View commit details
    Browse the repository at this point in the history

  7. combine black with the lint workflow

    @mcflugen
    mcflugen committed Oct 22, 2022
    Configuration menu
    Copy the full SHA
    ec1fc29 View commit details
    Browse the repository at this point in the history

  8. add a news fragment

    @mcflugen
    mcflugen committed Oct 22, 2022
    Configuration menu
    Copy the full SHA
    09eb7ba View commit details
    Browse the repository at this point in the history

  9. remove the makefile for building the docs

    @mcflugen
    mcflugen committed Oct 22, 2022
    Configuration menu
    Copy the full SHA
    beeceda View commit details
    Browse the repository at this point in the history

  10. update names of nox sessions

    @mcflugen
    mcflugen committed Oct 22, 2022
    Configuration menu
    Copy the full SHA
    14347f3 View commit details
    Browse the repository at this point in the history

  11. remove the old sidebar templates

    @mcflugen
    mcflugen committed Oct 22, 2022
    Configuration menu
    Copy the full SHA
    2b55af3 View commit details
    Browse the repository at this point in the history

  12. move the docs up one level

    @mcflugen
    mcflugen committed Oct 22, 2022
    Configuration menu
    Copy the full SHA
    e574d7d View commit details
    Browse the repository at this point in the history

  13. update location of conf.py

    @mcflugen
    mcflugen committed Oct 22, 2022
    Configuration menu
    Copy the full SHA
    a8a6ae3 View commit details
    Browse the repository at this point in the history

  14. try the dirhtml builder on readthedocs

    @mcflugen
    mcflugen committed Oct 22, 2022
    Configuration menu
    Copy the full SHA
    c71ceb7 View commit details
    Browse the repository at this point in the history