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

Restructuring the existing documentation #244

Merged
merged 11 commits into from
Mar 30, 2022
Merged

Restructuring the existing documentation #244

merged 11 commits into from
Mar 30, 2022

Commits on Mar 26, 2022

  1. [docs] include private modules (starting with _ in API) 

    `_processors` wasn't there before
    @gipert
    gipert committed Mar 26, 2022
    Configuration menu
    Copy the full SHA
    278afe2 View commit details
    Browse the repository at this point in the history

  2. [docs] enable Sphinx intersphinx extension for referencing external d… 

    …ocumentation
    @gipert
    gipert committed Mar 26, 2022
    Configuration menu
    Copy the full SHA
    cbc3128 View commit details
    Browse the repository at this point in the history

  3. Move (and reformat) docs from READMEs to Python code 

    Create missing `__init__.py` files
    @gipert
    gipert committed Mar 26, 2022
    Configuration menu
    Copy the full SHA
    560e444 View commit details
    Browse the repository at this point in the history

  4. [docs] fix docstring in dsp.errors

    @gipert
    gipert committed Mar 26, 2022
    Configuration menu
    Copy the full SHA
    5a27638 View commit details
    Browse the repository at this point in the history

  5. [docs] add Sphinx autosectionlabel extension

    @gipert
    gipert committed Mar 26, 2022
    Configuration menu
    Copy the full SHA
    5cda243 View commit details
    Browse the repository at this point in the history

  6. [docs] Add draft section about documentation in contribution guidelines

    @gipert
    gipert committed Mar 26, 2022
    Configuration menu
    Copy the full SHA
    d55ff88 View commit details
    Browse the repository at this point in the history

Commits on Mar 28, 2022

  1. Update setup.py authors and add PyPI classifiers

    @gipert
    gipert committed Mar 28, 2022
    Configuration menu
    Copy the full SHA
    d6c1e28 View commit details
    Browse the repository at this point in the history

  2. [docs] finish drafting section about documentation

    @gipert
    gipert committed Mar 28, 2022
    Configuration menu
    Copy the full SHA
    1d05548 View commit details
    Browse the repository at this point in the history

Commits on Mar 29, 2022

  1. [docs] Update section about unit tests in contributon guide

    @gipert
    gipert committed Mar 29, 2022
    Configuration menu
    Copy the full SHA
    e66af5b View commit details
    Browse the repository at this point in the history

  2. [docs] reorganise homepage & other minor modifications

    @gipert
    gipert committed Mar 29, 2022
    Configuration menu
    Copy the full SHA
    200c3ae View commit details
    Browse the repository at this point in the history

Commits on Mar 30, 2022

  1. [docs] mention pytest docs in contributing guide

    @gipert
    gipert committed Mar 30, 2022
    Configuration menu
    Copy the full SHA
    e23821f View commit details
    Browse the repository at this point in the history