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

Update docs #2373

Merged
merged 38 commits into from
Jul 20, 2023
Merged

Update docs #2373

merged 38 commits into from
Jul 20, 2023

Commits on Jul 4, 2023

  1. Update environment.yml and setup.cfg to latest version of sphinx

    @aknierim
    aknierim committed Jul 4, 2023
    Configuration menu
    Copy the full SHA
    0c13026 View commit details
    Browse the repository at this point in the history

  2. Moved docs/_static/theme_overrides.css to docs/_static/ctapipe.css

    @aknierim
    aknierim committed Jul 4, 2023
    Configuration menu
    Copy the full SHA
    501f2a9 View commit details
    Browse the repository at this point in the history

  3. Added logos dark/light

    @aknierim
    aknierim committed Jul 4, 2023
    Configuration menu
    Copy the full SHA
    135df80 View commit details
    Browse the repository at this point in the history

  4. Updated docs, added version switcher 

    * Added PyData theme
* Modified front page
* Fixed warnings during build of the docs with the Sphinx 6.2.1
* Added version switcher
    @aknierim
    aknierim committed Jul 4, 2023
    Configuration menu
    Copy the full SHA
    11275ed View commit details
    Browse the repository at this point in the history

  5. Update setup.cfg pydata dependency

    @aknierim
    aknierim committed Jul 4, 2023
    Configuration menu
    Copy the full SHA
    c1eef15 View commit details
    Browse the repository at this point in the history

  6. Added sphinx-design

    @aknierim
    aknierim committed Jul 4, 2023
    Configuration menu
    Copy the full SHA
    a76a43d View commit details
    Browse the repository at this point in the history

  7. Update environment.yml and setup.cfg to latest version of sphinx

    @aknierim
    aknierim committed Jul 4, 2023
    Configuration menu
    Copy the full SHA
    c60a81e View commit details
    Browse the repository at this point in the history

  8. Moved docs/_static/theme_overrides.css to docs/_static/ctapipe.css

    @aknierim
    aknierim committed Jul 4, 2023
    Configuration menu
    Copy the full SHA
    658fb6a View commit details
    Browse the repository at this point in the history

  9. Added logos dark/light

    @aknierim
    aknierim committed Jul 4, 2023
    Configuration menu
    Copy the full SHA
    d2a6d54 View commit details
    Browse the repository at this point in the history

  10. Updated docs, added version switcher 

    * Added PyData theme
* Modified front page
* Fixed warnings during build of the docs with the Sphinx 6.2.1
* Added version switcher
    @aknierim
    aknierim committed Jul 4, 2023
    Configuration menu
    Copy the full SHA
    b97b531 View commit details
    Browse the repository at this point in the history

  11. Update setup.cfg pydata dependency

    @aknierim
    aknierim committed Jul 4, 2023
    Configuration menu
    Copy the full SHA
    40aab03 View commit details
    Browse the repository at this point in the history

  12. Added sphinx-design

    @aknierim
    aknierim committed Jul 4, 2023
    Configuration menu
    Copy the full SHA
    bc9d6d7 View commit details
    Browse the repository at this point in the history

  13. Merge branch 'update-docs' of github.com:aknierim/ctapipe into update… 

    …-docs
    @aknierim
    aknierim committed Jul 4, 2023
    Configuration menu
    Copy the full SHA
    1050126 View commit details
    Browse the repository at this point in the history

  14. Fixed sphinx warning for ctapipe.compat.StrEnum

    @aknierim
    aknierim committed Jul 4, 2023
    Configuration menu
    Copy the full SHA
    07ce4ba View commit details
    Browse the repository at this point in the history

Commits on Jul 5, 2023

  1. Fixed sphinx warnings for ctapipe.instrument 

    * Fixed warnings by changing ``automodapi`` to ``automodule`` at certain
  locations
* Added change log rst file
* Removed unused import of ``pydata_sphinx_theme``
* Updated environment.yml
    @aknierim
    aknierim committed Jul 5, 2023
    Configuration menu
    Copy the full SHA
    c025fe3 View commit details
    Browse the repository at this point in the history

  2. Attempt at a temporary workaround

    @aknierim
    aknierim committed Jul 5, 2023
    Configuration menu
    Copy the full SHA
    2aed4de View commit details
    Browse the repository at this point in the history

  3. Added :noindex: option to certain rst files 

    * Added ``:noindex:`` to get rid of warnings
* Works at least locally
    @aknierim
    aknierim committed Jul 5, 2023
    Configuration menu
    Copy the full SHA
    8b60b9a View commit details
    Browse the repository at this point in the history

Commits on Jul 7, 2023

  1. Workarounds for duplicate reference warnings 

    * use autosummary and some manually added titles instead of automodapi
  in ``ctapipe_api/instrument/camera.rst`` and ``ctapipe_api/calib/index.rst``
* allows to circumvent duplicate reference warnings
* removed ``nipick_ignore`` entries added in previous commits of this
  ``update-docs`` branch
    @aknierim
    aknierim committed Jul 7, 2023
    Configuration menu
    Copy the full SHA
    f3f6d00 View commit details
    Browse the repository at this point in the history

  2. Fix heading issue

    @aknierim
    aknierim committed Jul 7, 2023
    Configuration menu
    Copy the full SHA
    958e5d9 View commit details
    Browse the repository at this point in the history

Commits on Jul 9, 2023

  1. Not adding to __all__ fixes automodapi warnings 

    Not adding to ``__all__`` in ``ctapipe/calib/index_camera/__init__.py``
and ``ctapipe/instrument/camera/__init__.py`` fixes nitpick warnings
with automodapi. Note that importing the modules is still necessary.
    @aknierim
    aknierim committed Jul 9, 2023
    Configuration menu
    Copy the full SHA
    1618eb1 View commit details
    Browse the repository at this point in the history

  2. Change back to automodapi, rework docs front page 

    * Change back to ``automodapi`` in ``ctapipe_api/calib/index.rst`` and
  ``ctapipe_api/instrument/camera.rst``
* Previous workaround no longer necessary
* Fix mobile layout of front page (grid cards now display correctly)
* Cleaner docs front page
    @aknierim
    aknierim committed Jul 9, 2023
    Configuration menu
    Copy the full SHA
    a99555b View commit details
    Browse the repository at this point in the history

Commits on Jul 10, 2023

  1. Ignore unused import warnings 

    Ignore unused import warnings in ``ctapipe/calib/camera/__init__.py``
``ctapipe/instrument/camera/__init__.py`` using ``noqa: F401``.
This will allow the linting CI to run successfully, while still allowing
the docs to be built with ``automodapi``.
    @aknierim
    aknierim committed Jul 10, 2023
    Configuration menu
    Copy the full SHA
    246639f View commit details
    Browse the repository at this point in the history

  2. Fix isort failing in ctapipe/instrument/camera/__init__.py

    @aknierim
    aknierim committed Jul 10, 2023
    Configuration menu
    Copy the full SHA
    3c0223b View commit details
    Browse the repository at this point in the history

  3. Remove html_sidebars option from conf.py

    @aknierim
    aknierim committed Jul 10, 2023
    Configuration menu
    Copy the full SHA
    099f601 View commit details
    Browse the repository at this point in the history

Commits on Jul 17, 2023

  1. Fix duplicated reference warning for muon components

    @maxnoe
    maxnoe committed Jul 17, 2023
    Configuration menu
    Copy the full SHA
    57d348f View commit details
    Browse the repository at this point in the history

  2. Fix broken html syntax in Component.__repr_html__

    @maxnoe
    maxnoe committed Jul 17, 2023
    Configuration menu
    Copy the full SHA
    c0dc668 View commit details
    Browse the repository at this point in the history

  3. Clear notebook outputs

    @maxnoe
    maxnoe committed Jul 17, 2023
    Configuration menu
    Copy the full SHA
    2f16d23 View commit details
    Browse the repository at this point in the history

  4. Fix add_css_file call in docs/conf.py

    @maxnoe
    maxnoe committed Jul 17, 2023
    Configuration menu
    Copy the full SHA
    4f5f051 View commit details
    Browse the repository at this point in the history

  5. Fix Tool repr_html and add html escaping

    @maxnoe
    maxnoe committed Jul 17, 2023
    Configuration menu
    Copy the full SHA
    63b9e63 View commit details
    Browse the repository at this point in the history

  6. Simplify __init__.py

    @maxnoe
    maxnoe committed Jul 17, 2023
    Configuration menu
    Copy the full SHA
    beb5fad View commit details
    Browse the repository at this point in the history

  7. Remove version switcher from navbar 

    * Remove version switcher since it needs to be updated by hand every time
a new version is released

* Remove now-obsolete ``docs/_static/switcher.json``

* Remove ``jinja2`` dependency from ``environment.yml``
    @aknierim
    aknierim committed Jul 17, 2023
    Configuration menu
    Copy the full SHA
    02798cb View commit details
    Browse the repository at this point in the history

  8. Add sidebar to all pages

    @aknierim
    aknierim committed Jul 17, 2023
    Configuration menu
    Copy the full SHA
    a089c49 View commit details
    Browse the repository at this point in the history

  9. Fix for failed CI/lint

    @aknierim
    aknierim committed Jul 17, 2023
    Configuration menu
    Copy the full SHA
    61547d2 View commit details
    Browse the repository at this point in the history

Commits on Jul 18, 2023

  1. Move content of caution admonition to announcement banner 

    * Move content of caution admonition block to announcement banner, as
  this results in a cleaner main page

* Remove ``html_sidebars`` for testing purposes
    @aknierim
    aknierim committed Jul 18, 2023
    Configuration menu
    Copy the full SHA
    22d2062 View commit details
    Browse the repository at this point in the history

  2. Add sphinx conf path to .readthedocs.yml

    @aknierim
    aknierim committed Jul 18, 2023
    Configuration menu
    Copy the full SHA
    2a6b6ed View commit details
    Browse the repository at this point in the history

  3. Add sidebars again 

    At least we have a version switcher for now
    @aknierim
    aknierim committed Jul 18, 2023
    Configuration menu
    Copy the full SHA
    854a84e View commit details
    Browse the repository at this point in the history

Commits on Jul 19, 2023

  1. Add navbar version switcher

    @aknierim
    aknierim committed Jul 19, 2023
    Configuration menu
    Copy the full SHA
    c782ba0 View commit details
    Browse the repository at this point in the history

  2. Fix versions in switcher.json 

    * Stable is now called stable (without version tag)
* Add colors to stable and dev versions in switcher
    @aknierim
    aknierim committed Jul 19, 2023
    Configuration menu
    Copy the full SHA
    05cc382 View commit details
    Browse the repository at this point in the history