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

Update documentation backend and reduce warnings in doc creation (#1199) #1205

Merged
merged 35 commits into from Aug 15, 2021

Commits on Jul 25, 2021

  1. Update documentation backend and reduce warnings in doc creation (#1199)

    * Remove __init_ from class_with_call doc template
    
    * Update api reference files .rst files
    
    * Tweak docstrings
    
    * more pydocstyle docs fixes
    
    * Update doc python object templates
    
    * Switch to numpydoc extension and pydata theme
    
    * Update doc requirements
    
    * Remove autosummary
    
    * Change docstring example to examples
    
    * Classification doc tweaks
    
    * Series transformer docstring tweaks
    
    * Change State docstring heading moved to notes
    
    * Annotation docstring tweaks
    
    * Tweak dataset docstrings
    
    * Additional docstring tweak
    
    * add twitter and discord icons
    
    * add edit-this-page button
    
    * remove estimator from init
    
    * More docstring tweaks based on numpydoc warnings
    
    * More numpydoc warning fixes
    
    * Add validation checks when building docs with numpydoc
    
    * Restructuring content
    
    * remove estimator table since it's auto-generated
    
    * Add getting started doc page
    
    Co-authored-by: mloning <markus.loning.17@ucl.ac.uk>
    RNKuhns and mloning committed Jul 25, 2021
    Configuration menu
    Copy the full SHA
    833e394 View commit details
    Browse the repository at this point in the history

Commits on Jul 26, 2021

  1. Add myst (#1206)

    * Remove __init_ from class_with_call doc template
    
    * Update api reference files .rst files
    
    * Tweak docstrings
    
    * more pydocstyle docs fixes
    
    * Update doc python object templates
    
    * Switch to numpydoc extension and pydata theme
    
    * Update doc requirements
    
    * Remove autosummary
    
    * Change docstring example to examples
    
    * Classification doc tweaks
    
    * Series transformer docstring tweaks
    
    * Change State docstring heading moved to notes
    
    * Annotation docstring tweaks
    
    * Tweak dataset docstrings
    
    * Additional docstring tweak
    
    * add twitter and discord icons
    
    * add edit-this-page button
    
    * remove estimator from init
    
    * More docstring tweaks based on numpydoc warnings
    
    * More numpydoc warning fixes
    
    * Add validation checks when building docs with numpydoc
    
    * Restructuring content
    
    * remove estimator table since it's auto-generated
    
    * replace m2r2 with myst
    
    Co-authored-by: Ryan Kuhns <rnkuhns@gmail.com>
    Markus Löning and RNKuhns committed Jul 26, 2021
    Configuration menu
    Copy the full SHA
    f7c30e7 View commit details
    Browse the repository at this point in the history
  2. Fix docstrings in sktime/datasets/

    mloning committed Jul 26, 2021
    Configuration menu
    Copy the full SHA
    e576a51 View commit details
    Browse the repository at this point in the history

Commits on Jul 28, 2021

  1. Merge additional pydocstyle error fixes into development docs (#1208)

    * Fix _fh.py docstrings
    
    * Remove __init_ from class_with_call doc template
    
    * Update api reference files .rst files
    
    * Tweak docstrings
    
    * more pydocstyle docs fixes
    
    * Update doc python object templates
    
    * Switch to numpydoc extension and pydata theme
    
    * Update doc requirements
    
    * Remove autosummary
    
    * Change docstring example to examples
    
    * Classification doc tweaks
    
    * Series transformer docstring tweaks
    
    * Change State docstring heading moved to notes
    
    * Annotation docstring tweaks
    
    * Tweak dataset docstrings
    
    * Additional docstring tweak
    
    * add twitter and discord icons
    
    * add edit-this-page button
    
    * remove estimator from init
    
    * More docstring tweaks based on numpydoc warnings
    
    * More numpydoc warning fixes
    
    * Add validation checks when building docs with numpydoc
    
    * Restructuring content
    
    * remove estimator table since it's auto-generated
    
    * Add getting started doc page
    
    * Fix annotation pydocstyle errors
    
    * Add module docstring in _meta.py
    
    * Fix pydocstyle errors in _rise.py
    
    * Fix pydocstyle errors in datasets
    
    * Fix pydocstyle error in regression/__init__.py
    
    * Fix pydocstyle errors in regression module
    
    * Fix pydocstyle errors in registry
    
    * Fix pydocstyle errors in performance_metrics
    
    * Fix series_as_features ensemble pydocstyle errors
    
    * Fix pydocstyle errors in forecasting base
    
    * Tweak language in performance_metrics docs
    
    * More pydocstyle error fixes in forecasting module
    
    * Still more pydocstyle error fixes in forecasting
    
    * Fix pydocstyle errors in forecasting model_evaluation
    
    * Forecasting adapter pydocstyle error fixes
    
    * Streamline getting started and fix code blocks
    
    * Add autodoc option to order members by source code
    
    * Update quickstart
    
    Co-authored-by: mloning <markus.loning.17@ucl.ac.uk>
    Co-authored-by: Markus Löning <markus.loning@gmail.com>
    3 people committed Jul 28, 2021
    Configuration menu
    Copy the full SHA
    93b06e0 View commit details
    Browse the repository at this point in the history
  2. Merge branch 'main' into docs-dev

    Markus Löning committed Jul 28, 2021
    Configuration menu
    Copy the full SHA
    59047b1 View commit details
    Browse the repository at this point in the history
  3. Docstring fixes

    mloning committed Jul 28, 2021
    Configuration menu
    Copy the full SHA
    75a2567 View commit details
    Browse the repository at this point in the history

Commits on Jul 30, 2021

  1. Add gallery for tutorials (#1158)

    * add gallery
    
    * add space
    
    * add manual thumbnails
    
    * Pin requirements
    
    * fix nbgallery
    Markus Löning committed Jul 30, 2021
    Configuration menu
    Copy the full SHA
    a4a9cae View commit details
    Browse the repository at this point in the history

Commits on Aug 1, 2021

  1. Fixing more sphinx warnings (#1231)

    * minor changes
    
    * minor changes
    Markus Löning committed Aug 1, 2021
    Configuration menu
    Copy the full SHA
    5c97803 View commit details
    Browse the repository at this point in the history
  2. Remove full module reference for API elements

    mloning committed Aug 1, 2021
    Configuration menu
    Copy the full SHA
    10bcd69 View commit details
    Browse the repository at this point in the history
  3. add glossary

    mloning committed Aug 1, 2021
    Configuration menu
    Copy the full SHA
    f02dc00 View commit details
    Browse the repository at this point in the history
  4. Configuration menu
    Copy the full SHA
    8e40ac0 View commit details
    Browse the repository at this point in the history
  5. Update .gitignore

    mloning committed Aug 1, 2021
    Configuration menu
    Copy the full SHA
    c1e238c View commit details
    Browse the repository at this point in the history
  6. Update structure, minor changes to content

    mloning committed Aug 1, 2021
    Configuration menu
    Copy the full SHA
    3bbdeac View commit details
    Browse the repository at this point in the history
  7. Fix home-button logo

    mloning committed Aug 1, 2021
    Configuration menu
    Copy the full SHA
    d37f3c1 View commit details
    Browse the repository at this point in the history

Commits on Aug 3, 2021

  1. Configuration menu
    Copy the full SHA
    a64ed00 View commit details
    Browse the repository at this point in the history
  2. Configuration menu
    Copy the full SHA
    09acc8e View commit details
    Browse the repository at this point in the history
  3. Configuration menu
    Copy the full SHA
    d8d9f7f View commit details
    Browse the repository at this point in the history
  4. Fix duplicate object description warnings

    mloning committed Aug 3, 2021
    Configuration menu
    Copy the full SHA
    6f2afe6 View commit details
    Browse the repository at this point in the history
  5. Sync with main

    mloning committed Aug 3, 2021
    Configuration menu
    Copy the full SHA
    10f3a2e View commit details
    Browse the repository at this point in the history
  6. Fix docstring

    mloning committed Aug 3, 2021
    Configuration menu
    Copy the full SHA
    40c931f View commit details
    Browse the repository at this point in the history

Commits on Aug 4, 2021

  1. Configuration menu
    Copy the full SHA
    9b5aeec View commit details
    Browse the repository at this point in the history
  2. Add sphinx.ext.sphinx_issues for links to GitHub

    mloning committed Aug 4, 2021
    Configuration menu
    Copy the full SHA
    9820b84 View commit details
    Browse the repository at this point in the history
  3. Minor fixes

    mloning committed Aug 4, 2021
    Configuration menu
    Copy the full SHA
    04cb3a2 View commit details
    Browse the repository at this point in the history
  4. Minor fixes

    mloning committed Aug 4, 2021
    Configuration menu
    Copy the full SHA
    b0d0ee7 View commit details
    Browse the repository at this point in the history

Commits on Aug 13, 2021

  1. Configuration menu
    Copy the full SHA
    7b4ba03 View commit details
    Browse the repository at this point in the history
  2. Update reviewer guide

    mloning committed Aug 13, 2021
    Configuration menu
    Copy the full SHA
    059db14 View commit details
    Browse the repository at this point in the history
  3. Additions to docs-dev (PR #1205) (#1274)

    * Fix _fh.py docstrings
    
    * Remove __init_ from class_with_call doc template
    
    * Update api reference files .rst files
    
    * Tweak docstrings
    
    * more pydocstyle docs fixes
    
    * Update doc python object templates
    
    * Switch to numpydoc extension and pydata theme
    
    * Update doc requirements
    
    * Remove autosummary
    
    * Change docstring example to examples
    
    * Classification doc tweaks
    
    * Series transformer docstring tweaks
    
    * Change State docstring heading moved to notes
    
    * Annotation docstring tweaks
    
    * Tweak dataset docstrings
    
    * Additional docstring tweak
    
    * add twitter and discord icons
    
    * add edit-this-page button
    
    * remove estimator from init
    
    * More docstring tweaks based on numpydoc warnings
    
    * More numpydoc warning fixes
    
    * Add validation checks when building docs with numpydoc
    
    * Restructuring content
    
    * remove estimator table since it's auto-generated
    
    * Add getting started doc page
    
    * Fix annotation pydocstyle errors
    
    * Add module docstring in _meta.py
    
    * Fix pydocstyle errors in _rise.py
    
    * Fix pydocstyle errors in datasets
    
    * Fix pydocstyle error in regression/__init__.py
    
    * Fix pydocstyle errors in regression module
    
    * Fix pydocstyle errors in registry
    
    * Fix pydocstyle errors in performance_metrics
    
    * Fix series_as_features ensemble pydocstyle errors
    
    * Fix pydocstyle errors in forecasting base
    
    * Tweak language in performance_metrics docs
    
    * More pydocstyle error fixes in forecasting module
    
    * Still more pydocstyle error fixes in forecasting
    
    * Fix pydocstyle errors in forecasting model_evaluation
    
    * Forecasting adapter pydocstyle error fixes
    
    * Streamline getting started and fix code blocks
    
    * Add autodoc option to order members by source code
    
    * Update quickstart
    
    * Add shell of perf metric user guide
    
    * Add more content to get_started.rst
    
    * Tweak installation in get_started
    
    * Tweak reference to user guide
    
    * Add content to get_started and glossary
    
    * Fix doc index page
    
    * Remove old user_documentation file
    
    * Add annotation quickstart example
    
    * Fix pydocstyle errors in _column_ensemble.py
    
    * Fix pydocstyle errors benchmarking/evaluation.py
    
    * Update get_started and glossary content
    
    * Add doc to dev guide
    
    * Add panels to additional pages
    
    * Fix get started and sphinx panels
    
    * About converted to .rst
    
    * Remove about.md
    
    * Fix Funding panel on about.rst
    
    * Fix about heading
    
    * Fix api ref panel
    
    * Fix text on panels
    
    Co-authored-by: mloning <markus.loning.17@ucl.ac.uk>
    Co-authored-by: Markus Löning <markus.loning@gmail.com>
    3 people committed Aug 13, 2021
    Configuration menu
    Copy the full SHA
    14e5812 View commit details
    Browse the repository at this point in the history
  4. Sync with main

    mloning committed Aug 13, 2021
    Configuration menu
    Copy the full SHA
    3a1b6c4 View commit details
    Browse the repository at this point in the history
  5. Fix merge conflicts between docs-dev and main (#1293)

    * Fix _fh.py docstrings
    
    * Remove __init_ from class_with_call doc template
    
    * Update api reference files .rst files
    
    * Tweak docstrings
    
    * more pydocstyle docs fixes
    
    * Update doc python object templates
    
    * Switch to numpydoc extension and pydata theme
    
    * Update doc requirements
    
    * Remove autosummary
    
    * Change docstring example to examples
    
    * Classification doc tweaks
    
    * Series transformer docstring tweaks
    
    * Change State docstring heading moved to notes
    
    * Annotation docstring tweaks
    
    * Tweak dataset docstrings
    
    * Additional docstring tweak
    
    * add twitter and discord icons
    
    * add edit-this-page button
    
    * remove estimator from init
    
    * More docstring tweaks based on numpydoc warnings
    
    * More numpydoc warning fixes
    
    * Add validation checks when building docs with numpydoc
    
    * Restructuring content
    
    * remove estimator table since it's auto-generated
    
    * Add getting started doc page
    
    * Fix annotation pydocstyle errors
    
    * Add module docstring in _meta.py
    
    * Fix pydocstyle errors in _rise.py
    
    * Fix pydocstyle errors in datasets
    
    * Fix pydocstyle error in regression/__init__.py
    
    * Fix pydocstyle errors in regression module
    
    * Fix pydocstyle errors in registry
    
    * Fix pydocstyle errors in performance_metrics
    
    * Fix series_as_features ensemble pydocstyle errors
    
    * Fix pydocstyle errors in forecasting base
    
    * Tweak language in performance_metrics docs
    
    * More pydocstyle error fixes in forecasting module
    
    * Still more pydocstyle error fixes in forecasting
    
    * Fix pydocstyle errors in forecasting model_evaluation
    
    * Forecasting adapter pydocstyle error fixes
    
    * Streamline getting started and fix code blocks
    
    * Add autodoc option to order members by source code
    
    * Update quickstart
    
    * Add shell of perf metric user guide
    
    * Add more content to get_started.rst
    
    * Tweak installation in get_started
    
    * Tweak reference to user guide
    
    * Add content to get_started and glossary
    
    * Fix doc index page
    
    * Remove old user_documentation file
    
    * Add annotation quickstart example
    
    * Fix pydocstyle errors in _column_ensemble.py
    
    * Fix pydocstyle errors benchmarking/evaluation.py
    
    * Update get_started and glossary content
    
    * Add doc to dev guide
    
    * Add panels to additional pages
    
    * Fix get started and sphinx panels
    
    * About converted to .rst
    
    * Remove about.md
    
    * Fix Funding panel on about.rst
    
    * Fix about heading
    
    * Fix api ref panel
    
    * Fix text on panels
    
    Co-authored-by: mloning <markus.loning.17@ucl.ac.uk>
    Co-authored-by: Markus Löning <markus.loning@gmail.com>
    3 people committed Aug 13, 2021
    Configuration menu
    Copy the full SHA
    291643d View commit details
    Browse the repository at this point in the history
  6. Fix cross ref in panels

    mloning committed Aug 13, 2021
    Configuration menu
    Copy the full SHA
    a0b75d2 View commit details
    Browse the repository at this point in the history
  7. Merge branch 'main' into docs-dev

    Markus Löning committed Aug 13, 2021
    Configuration menu
    Copy the full SHA
    bdd26df View commit details
    Browse the repository at this point in the history

Commits on Aug 14, 2021

  1. Fix code quality

    mloning committed Aug 14, 2021
    Configuration menu
    Copy the full SHA
    5a8cecb View commit details
    Browse the repository at this point in the history
  2. Merge branch 'main' into docs-dev

    Markus Löning committed Aug 14, 2021
    Configuration menu
    Copy the full SHA
    5e08d50 View commit details
    Browse the repository at this point in the history
  3. Fix code quality

    mloning committed Aug 14, 2021
    Configuration menu
    Copy the full SHA
    53a3022 View commit details
    Browse the repository at this point in the history
  4. Fix remaining issues in docs-dev branch (#1294)

    * Fix pydocstyle error in benchmarking methods
    
    * Fix docstring indentation
    RNKuhns committed Aug 14, 2021
    Configuration menu
    Copy the full SHA
    cafb5e5 View commit details
    Browse the repository at this point in the history