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 proper docstrings in Numpy Style #22

Draft
wants to merge 16 commits into
base: develop
Choose a base branch
from
Draft

Add proper docstrings in Numpy Style #22

wants to merge 16 commits into from

Commits on Aug 18, 2021

  1. Add support for API documentation

    @DanielKotik
    DanielKotik committed Aug 18, 2021
    Configuration menu
    Copy the full SHA
    6a2f981 View commit details
    Browse the repository at this point in the history

  2. Add Python style checks to CI

    @DanielKotik
    DanielKotik committed Aug 18, 2021
    Configuration menu
    Copy the full SHA
    9c34cb6 View commit details
    Browse the repository at this point in the history

Commits on Aug 19, 2021

  1. Update .gitignore

    @DanielKotik
    DanielKotik committed Aug 19, 2021
    Configuration menu
    Copy the full SHA
    eeaeb0d View commit details
    Browse the repository at this point in the history

  2. Fix docs in __init__.py

    @DanielKotik
    DanielKotik committed Aug 19, 2021
    Configuration menu
    Copy the full SHA
    f475f79 View commit details
    Browse the repository at this point in the history

  3. Update workflow to generate API docs

    @DanielKotik
    DanielKotik committed Aug 19, 2021
    Configuration menu
    Copy the full SHA
    3334f4d View commit details
    Browse the repository at this point in the history

Commits on Aug 20, 2021

  1. Improve docstrings for Laguerre-Gauss class

    @DanielKotik
    DanielKotik committed Aug 20, 2021
    Configuration menu
    Copy the full SHA
    7d5cae4 View commit details
    Browse the repository at this point in the history

  2. Complete docstring for spectrum

    @DanielKotik
    DanielKotik committed Aug 20, 2021
    Configuration menu
    Copy the full SHA
    9a6f625 View commit details
    Browse the repository at this point in the history

  3. Improve docstrings for IncAiry2d

    @DanielKotik
    DanielKotik committed Aug 20, 2021
    Configuration menu
    Copy the full SHA
    53d01bb View commit details
    Browse the repository at this point in the history

Commits on Aug 23, 2021

  1. Add reference to classes in top module docsting

    @DanielKotik
    DanielKotik committed Aug 23, 2021
    Configuration menu
    Copy the full SHA
    f202ea1 View commit details
    Browse the repository at this point in the history

Commits on Aug 25, 2021

  1. Add module docstrings

    @DanielKotik
    DanielKotik committed Aug 25, 2021
    Configuration menu
    Copy the full SHA
    d0762d7 View commit details
    Browse the repository at this point in the history

Commits on Aug 26, 2021

  1. Merge branch 'develop' into apidoc

    @DanielKotik
    DanielKotik committed Aug 26, 2021
    Configuration menu
    Copy the full SHA
    44fe056 View commit details
    Browse the repository at this point in the history

  2. Add docstring template

    @DanielKotik
    DanielKotik committed Aug 26, 2021
    Configuration menu
    Copy the full SHA
    483ae5b View commit details
    Browse the repository at this point in the history

  3. Remove not allowed blank line

    @DanielKotik
    DanielKotik committed Aug 26, 2021
    Configuration menu
    Copy the full SHA
    42288a7 View commit details
    Browse the repository at this point in the history

  4. Add some types to docstrings

    @DanielKotik
    DanielKotik committed Aug 26, 2021
    Configuration menu
    Copy the full SHA
    12c61b6 View commit details
    Browse the repository at this point in the history

  5. Add a docstring

    @DanielKotik
    DanielKotik committed Aug 26, 2021
    Configuration menu
    Copy the full SHA
    1fc62a8 View commit details
    Browse the repository at this point in the history

Commits on Aug 29, 2021

  1. Use customized api docs files: 

    - exclude helper module from documentation
- remove `sphinx-apidocs` from pipeline
    @DanielKotik
    DanielKotik committed Aug 29, 2021
    Configuration menu
    Copy the full SHA
    2dd8872 View commit details
    Browse the repository at this point in the history