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 docs #2373

Merged
merged 38 commits into from
Jul 20, 2023
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
38 commits
Select commit Hold shift + click to select a range
0c13026
Update environment.yml and setup.cfg to latest version of sphinx
aknierim Jul 4, 2023
501f2a9
Moved docs/_static/theme_overrides.css to docs/_static/ctapipe.css
aknierim Jul 4, 2023
135df80
Added logos dark/light
aknierim Jul 4, 2023
11275ed
Updated docs, added version switcher
aknierim Jul 4, 2023
c1eef15
Update setup.cfg pydata dependency
aknierim Jul 4, 2023
a76a43d
Added sphinx-design
aknierim Jul 4, 2023
c60a81e
Update environment.yml and setup.cfg to latest version of sphinx
aknierim Jul 4, 2023
658fb6a
Moved docs/_static/theme_overrides.css to docs/_static/ctapipe.css
aknierim Jul 4, 2023
d2a6d54
Added logos dark/light
aknierim Jul 4, 2023
b97b531
Updated docs, added version switcher
aknierim Jul 4, 2023
40aab03
Update setup.cfg pydata dependency
aknierim Jul 4, 2023
bc9d6d7
Added sphinx-design
aknierim Jul 4, 2023
1050126
Merge branch 'update-docs' of github.com:aknierim/ctapipe into update…
aknierim Jul 4, 2023
07ce4ba
Fixed sphinx warning for ctapipe.compat.StrEnum
aknierim Jul 4, 2023
c025fe3
Fixed sphinx warnings for `ctapipe.instrument`
aknierim Jul 5, 2023
2aed4de
Attempt at a temporary workaround
aknierim Jul 5, 2023
8b60b9a
Added ``:noindex:`` option to certain rst files
aknierim Jul 5, 2023
f3f6d00
Workarounds for duplicate reference warnings
aknierim Jul 7, 2023
958e5d9
Fix heading issue
aknierim Jul 7, 2023
1618eb1
Not adding to __all__ fixes automodapi warnings
aknierim Jul 9, 2023
a99555b
Change back to automodapi, rework docs front page
aknierim Jul 9, 2023
246639f
Ignore unused import warnings
aknierim Jul 10, 2023
3c0223b
Fix isort failing in ctapipe/instrument/camera/__init__.py
aknierim Jul 10, 2023
099f601
Remove html_sidebars option from conf.py
aknierim Jul 10, 2023
57d348f
Fix duplicated reference warning for muon components
maxnoe Jul 17, 2023
c0dc668
Fix broken html syntax in Component.__repr_html__
maxnoe Jul 17, 2023
2f16d23
Clear notebook outputs
maxnoe Jul 17, 2023
4f5f051
Fix add_css_file call in docs/conf.py
maxnoe Jul 17, 2023
63b9e63
Fix Tool repr_html and add html escaping
maxnoe Jul 17, 2023
beb5fad
Simplify __init__.py
maxnoe Jul 17, 2023
02798cb
Remove version switcher from navbar
aknierim Jul 17, 2023
a089c49
Add sidebar to all pages
aknierim Jul 17, 2023
61547d2
Fix for failed CI/lint
aknierim Jul 17, 2023
22d2062
Move content of caution admonition to announcement banner
aknierim Jul 18, 2023
2a6b6ed
Add sphinx conf path to .readthedocs.yml
aknierim Jul 18, 2023
854a84e
Add sidebars again
aknierim Jul 18, 2023
c782ba0
Add navbar version switcher
aknierim Jul 19, 2023
05cc382
Fix versions in switcher.json
aknierim Jul 19, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
10 changes: 8 additions & 2 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@


numpydoc_show_class_members = False
# numpydoc_class_members_toctree = False
numpydoc_class_members_toctree = False
nbsphinx_timeout = 200 # allow max 2 minutes to build each notebook


Expand Down Expand Up @@ -128,10 +128,15 @@ def setup(app):
("py:class", "ctapipe.compat.StrEnum"),
]

# temporary fixes to ignore reference warnings and ensure build
# temporary workaround to ignore reference warnings and ensure build
nitpick_ignore += [
("py:obj", "ctapipe.calib.CameraCalibrator"),
("py:obj", "ctapipe.calib.GainSelector"),
("py:obj", "CameraGeometry"),
maxnoe marked this conversation as resolved.
Show resolved Hide resolved
("py:obj", "ctapipe.instrument.camera.CameraGeometry"),
("py:obj", "ctapipe.instrument.camera.CameraDescription"),
("py:obj", "ctapipe.instrument.camera.PixelShape"),
("py:obj", "ctapipe.instrument.camera.CameraReadout"),
]

# The suffix(es) of source filenames.
Expand Down Expand Up @@ -256,6 +261,7 @@ def setup(app):

html_sidebars = {
"**": ["sidebar-nav-bs.html", "sidebar-ethical-ads.html"],
"index.rst": [],
}


Expand Down
2 changes: 1 addition & 1 deletion docs/ctapipe_api/instrument/camera_geometry.rst
Original file line number Diff line number Diff line change
Expand Up @@ -91,4 +91,4 @@ Reference/API
=============

.. automodapi:: ctapipe.instrument.camera.geometry
:no-inheritance-diagram:
:no-inheritance-diagram:
4 changes: 2 additions & 2 deletions docs/ctapipe_api/instrument/camera_readout.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,8 @@ Input/Output


You can write out a `CameraReadout` by using the ``CameraReadout.to_table()``
method to turn it into a `~astropy.table.Table`, and then call its ``write()``
function. Reading it back in can be done with ``CameraReadout.from_table()``.
method to turn it into a `~astropy.table.Table`, and then call its ``write()``
function. Reading it back in can be done with ``CameraReadout.from_table()``.

.. code-block:: python

Expand Down