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: Automatic Code Documentation #698

Merged
merged 30 commits into from Jun 9, 2023
Merged

docs: Automatic Code Documentation #698

merged 30 commits into from Jun 9, 2023

Commits on May 24, 2023

  1. docs: automatic generation of code documentation 

    Signed-off-by: Victor Garcia Reolid <victor@seita.nl>
    @victorgarcia98
    victorgarcia98 committed May 24, 2023
    Configuration menu
    Copy the full SHA
    58fc26f View commit details
    Browse the repository at this point in the history

  2. docs: class and module templates 

    Signed-off-by: Victor Garcia Reolid <victor@seita.nl>
    @victorgarcia98
    victorgarcia98 committed May 24, 2023
    Configuration menu
    Copy the full SHA
    51b4f7c View commit details
    Browse the repository at this point in the history

  3. fix: simplify generated docs 

    Signed-off-by: Victor Garcia Reolid <victor@seita.nl>
    @victorgarcia98
    victorgarcia98 committed May 24, 2023
    Configuration menu
    Copy the full SHA
    0010661 View commit details
    Browse the repository at this point in the history

  4. feat: switch on/off generation of code docs via the parameter gen_cod… 

    …e_docs of the makefile command update-docs and update-docs-pdf

Signed-off-by: Victor Garcia Reolid <victor@seita.nl>
    @victorgarcia98
    victorgarcia98 committed May 24, 2023
    Configuration menu
    Copy the full SHA
    1c0ddbc View commit details
    Browse the repository at this point in the history

Commits on May 26, 2023

  1. add docstrings for main modules 

    Signed-off-by: Nicolas Höning <nicolas@seita.nl>
    @nhoening
    nhoening committed May 26, 2023
    Configuration menu
    Copy the full SHA
    4e22c78 View commit details
    Browse the repository at this point in the history

  2. Add docstrings to API modules 

    Signed-off-by: Nicolas Höning <nicolas@seita.nl>
    @nhoening
    nhoening committed May 26, 2023
    Configuration menu
    Copy the full SHA
    a1c64a5 View commit details
    Browse the repository at this point in the history

Commits on May 29, 2023

  1. fix: add autodoc and autosmmary when GEN_CODE_DOCS=True 

    Signed-off-by: Victor Garcia Reolid <victor@seita.nl>
    @victorgarcia98
    victorgarcia98 committed May 29, 2023
    Configuration menu
    Copy the full SHA
    7486a87 View commit details
    Browse the repository at this point in the history

  2. fix: set gen_code_docs default to True and False for devs (calling up… 

    …date-docs using make)

Signed-off-by: Victor Garcia Reolid <victor@seita.nl>
    @victorgarcia98
    victorgarcia98 committed May 29, 2023
    Configuration menu
    Copy the full SHA
    7eb4771 View commit details
    Browse the repository at this point in the history

  3. Merge branch 'main' into 52-incomplete-documentation-of-internal-modules

    @victorgarcia98
    victorgarcia98 committed May 29, 2023
    Configuration menu
    Copy the full SHA
    93c502e View commit details
    Browse the repository at this point in the history

Commits on May 30, 2023

  1. Merge branch 'main' into 52-incomplete-documentation-of-internal-modules

    @victorgarcia98
    victorgarcia98 committed May 30, 2023
    Configuration menu
    Copy the full SHA
    dc7bf84 View commit details
    Browse the repository at this point in the history

Commits on Jun 6, 2023

  1. move single test from config package into new tests package 

    Signed-off-by: Nicolas Höning <nicolas@seita.nl>
    @nhoening
    nhoening committed Jun 6, 2023
    Configuration menu
    Copy the full SHA
    5dba038 View commit details
    Browse the repository at this point in the history

Commits on Jun 7, 2023

  1. fix: show main modules 

    Signed-off-by: Victor Garcia Reolid <victor@seita.nl>
    @victorgarcia98
    victorgarcia98 committed Jun 7, 2023
    Configuration menu
    Copy the full SHA
    76c7315 View commit details
    Browse the repository at this point in the history

  2. fix: remove documentation/_autosummary when gen_code_docs=False 

    Signed-off-by: Victor Garcia Reolid <victor@seita.nl>
    @victorgarcia98
    victorgarcia98 committed Jun 7, 2023
    Configuration menu
    Copy the full SHA
    6f67b12 View commit details
    Browse the repository at this point in the history

  3. fix: make generated rst to live under _autosummary/ folder 

    Signed-off-by: Victor Garcia Reolid <victor@seita.nl>
    @victorgarcia98
    victorgarcia98 committed Jun 7, 2023
    Configuration menu
    Copy the full SHA
    a557df2 View commit details
    Browse the repository at this point in the history

  4. add autosummary folder to .gitignore 

    Signed-off-by: Nicolas Höning <nicolas@seita.nl>
    @nhoening
    nhoening committed Jun 7, 2023
    Configuration menu
    Copy the full SHA
    a49ae85 View commit details
    Browse the repository at this point in the history

  5. add some spellright words 

    Signed-off-by: Nicolas Höning <nicolas@seita.nl>
    @nhoening
    nhoening committed Jun 7, 2023
    Configuration menu
    Copy the full SHA
    8d7ff4a View commit details
    Browse the repository at this point in the history

  6. try setting FLASK_ENV during RTD building 

    Signed-off-by: Nicolas Höning <nicolas@seita.nl>
    @nhoening
    nhoening committed Jun 7, 2023
    Configuration menu
    Copy the full SHA
    a569f3f View commit details
    Browse the repository at this point in the history

  7. fix: set a fake SQLALCHEMY_DATABASE_URI 

    Signed-off-by: Victor Garcia Reolid <victor@seita.nl>
    @victorgarcia98
    victorgarcia98 committed Jun 7, 2023
    Configuration menu
    Copy the full SHA
    7dadf17 View commit details
    Browse the repository at this point in the history

  8. Merge remote-tracking branch 'origin/52-incomplete-documentation-of-i… 

    …nternal-modules' into 52-incomplete-documentation-of-internal-modules

Signed-off-by: Victor Garcia Reolid <victor@seita.nl>
    @victorgarcia98
    victorgarcia98 committed Jun 7, 2023
    Configuration menu
    Copy the full SHA
    fbb5a4f View commit details
    Browse the repository at this point in the history

  9. no need to look for config file when building documentation 

    Signed-off-by: Nicolas Höning <nicolas@seita.nl>
    @nhoening
    nhoening committed Jun 7, 2023
    Configuration menu
    Copy the full SHA
    36b47ea View commit details
    Browse the repository at this point in the history

  10. Merge branch '52-incomplete-documentation-of-internal-modules' of git… 

    …hub.com:FlexMeasures/flexmeasures into 52-incomplete-documentation-of-internal-modules
    @nhoening
    nhoening committed Jun 7, 2023
    Configuration menu
    Copy the full SHA
    72747a6 View commit details
    Browse the repository at this point in the history

  11. also export SECRET_KEY in RTD 

    Signed-off-by: Nicolas Höning <nicolas@seita.nl>
    @nhoening
    nhoening committed Jun 7, 2023
    Configuration menu
    Copy the full SHA
    94a00e2 View commit details
    Browse the repository at this point in the history

  12. test add SECRET_KEY 

    Signed-off-by: Victor Garcia Reolid <victor@seita.nl>
    @victorgarcia98
    victorgarcia98 committed Jun 7, 2023
    Configuration menu
    Copy the full SHA
    cb6d9e8 View commit details
    Browse the repository at this point in the history

  13. Merge remote-tracking branch 'origin/52-incomplete-documentation-of-i… 

    …nternal-modules' into 52-incomplete-documentation-of-internal-modules
    @victorgarcia98
    victorgarcia98 committed Jun 7, 2023
    Configuration menu
    Copy the full SHA
    b66ca03 View commit details
    Browse the repository at this point in the history

  14. docs: add private methods 

    Signed-off-by: Victor Garcia Reolid <victor@seita.nl>
    @victorgarcia98
    victorgarcia98 committed Jun 7, 2023
    Configuration menu
    Copy the full SHA
    23b5595 View commit details
    Browse the repository at this point in the history

Commits on Jun 8, 2023

  1. test only with env variables set in conf.py 

    Signed-off-by: Victor Garcia Reolid <victor@seita.nl>
    @victorgarcia98
    victorgarcia98 committed Jun 8, 2023
    Configuration menu
    Copy the full SHA
    777ee3f View commit details
    Browse the repository at this point in the history

  2. test 

    Signed-off-by: Victor Garcia Reolid <victor@seita.nl>
    @victorgarcia98
    victorgarcia98 committed Jun 8, 2023
    Configuration menu
    Copy the full SHA
    f0720ce View commit details
    Browse the repository at this point in the history

  3. fix: remove exports 

    Signed-off-by: Victor Garcia Reolid <victor@seita.nl>
    @victorgarcia98
    victorgarcia98 committed Jun 8, 2023
    Configuration menu
    Copy the full SHA
    e0c6373 View commit details
    Browse the repository at this point in the history

Commits on Jun 9, 2023

  1. re-do a change to a comment that is by now inaccurate and improve the… 

    … comment, as well

Signed-off-by: Nicolas Höning <nicolas@seita.nl>
    @nhoening
    nhoening committed Jun 9, 2023
    Configuration menu
    Copy the full SHA
    78724fa View commit details
    Browse the repository at this point in the history

  2. Merge branch 'main' into 52-incomplete-documentation-of-internal-modules

    @nhoening
    nhoening committed Jun 9, 2023
    Configuration menu
    Copy the full SHA
    1bfcf83 View commit details
    Browse the repository at this point in the history