Skip to content

Commit

Permalink
Change back to automodapi, rework docs front page
Browse files Browse the repository at this point in the history
* 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
  • Loading branch information
aknierim committed Jul 9, 2023
1 parent 1618eb1 commit a99555b
Show file tree
Hide file tree
Showing 5 changed files with 29 additions and 78 deletions.
26 changes: 5 additions & 21 deletions docs/ctapipe_api/calib/index.rst
Original file line number Diff line number Diff line change
@@ -1,12 +1,9 @@
.. _calib:

.. temporary worakaround to at least have calib in the title,
the reason is the usage of autosummary in the Reference/API
section below

========================================
Calibration (``calib``)
========================================
==============================
Calibration (`~ctapipe.calib`)
==============================

.. currentmodule:: ctapipe.calib

Expand Down Expand Up @@ -48,18 +45,5 @@ Submodules
Reference/API
=============

.. What follows is a *temporary* workaround to circumvent
various warnings of duplicate references caused by
calling automodapi on the camera package.
ctapipe.calib Package
---------------------

Calibration

Classes
^^^^^^^

.. autosummary::
~camera.CameraCalibrator
~camera.GainSelector
.. automodapi:: ctapipe.calib
:no-inheritance-diagram:
2 changes: 1 addition & 1 deletion docs/ctapipe_api/calib/index_camera.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ CTA Cameras (MC, prototypes and final camera calibration algorithms).
CameraCalibrator
****************

The primary class in this module is the :class:`.CameraCalibrator`. This class handles
The primary class in this module is the `~ctapipe.calib.camera.calibrator.CameraCalibrator`. This class handles
two data level transition stages for the event:

* R1 -> DL0 (:ref:`image_reducers`)
Expand Down
25 changes: 4 additions & 21 deletions docs/ctapipe_api/instrument/camera.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@
Camera Description
==================

The `~CameraDescription` contains classes holding information about the
Cherenkov camera, namely the `~CameraGeometry` and `~CameraReadout` classes.
The `~camera.description.CameraDescription` contains classes holding information about the
Cherenkov camera, namely the `~camera.geometry.CameraGeometry` and `~camera.readout.CameraReadout` classes.


.. toctree::
Expand All @@ -19,25 +19,8 @@ Cherenkov camera, namely the `~CameraGeometry` and `~CameraReadout` classes.
Reference/API
=============

.. What follows is a temporary workaround to circumvent
various warnings of duplicate references caused by
calling automodapi on the camera package.
ctapipe.instrument.camera Package
---------------------------------


Classes
^^^^^^^

.. autosummary::

~CameraDescription
~CameraGeometry
~PixelShape
~camera.geometry.UnknownPixelShapeWarning
~CameraReadout

.. automodapi:: ctapipe.instrument.camera
:no-inheritance-diagram:

.. automodapi:: ctapipe.instrument.camera.description
:no-inheritance-diagram:
4 changes: 2 additions & 2 deletions docs/development/index.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. _guidelines:

Development Guidelines
======================
Coding Guidelines
=================

.. toctree::

Expand Down
50 changes: 17 additions & 33 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
.. include:: references.txt

:html_theme.sidebar_secondary.remove: true
:html_theme.sidebar_primary.remove: true

.. _ctapipe:

Expand All @@ -10,7 +11,7 @@ Prototype CTA Pipeline Framework (``ctapipe``)

.. currentmodule:: ctapipe

**Version**: |version|
|
.. image:: ctapipe_logo.webp
:class: only-light
Expand All @@ -24,8 +25,18 @@ Prototype CTA Pipeline Framework (``ctapipe``)
:width: 90%
:alt: The ctapipe logo.

What is ctapipe?
================
|
**Date**: |today| **Version**: |version|

**Useful links**:
`Source Repository <https://github.com/cta-observatory/ctapipe>`__ |
`Issue Tracker <https://github.com/cta-observatory/ctapipe/issues>`__ |
`Discussions <https://github.com/cta-observatory/ctapipe/discussions>`__

**License**: BSD-3 **Python**: |python_requires|

|
``ctapipe`` is a framework for prototyping the low-level data processing algorithms for the Cherenkov Telescope Array.

Expand All @@ -34,18 +45,9 @@ What is ctapipe?
structure and functionality as we explore various design choices before
the 1.0 release.

* Code, feature requests, bug reports, pull requests: https://github.com/cta-observatory/ctapipe
* Docs: https://ctapipe.readthedocs.io/
* License: BSD-3
* Python: |python_requires|



.. _ctapipe_docs:

.. General documentation
.. =====================
.. toctree::
:maxdepth: 1
:hidden:
Expand All @@ -64,7 +66,7 @@ What is ctapipe?



.. grid:: 3
.. grid:: 1 2 2 3

.. grid-item-card::

Expand Down Expand Up @@ -111,8 +113,8 @@ What is ctapipe?

:octicon:`git-pull-request;40px`

Development Guidelines
^^^^^^^^^^^^^^^^^^^^^^
Coding Guidelines
^^^^^^^^^^^^^^^^^

These guidelines explain the coding style and the workflow. The ctapipe
enhancement proposals (CEPs) can also be found here.
Expand Down Expand Up @@ -186,21 +188,3 @@ What is ctapipe?

To the examples


Module API Status (relative to next release)
============================================

ctapipe is under activate developement and we will make breaking changes from release to release until
we reach version 1.0.


Development Help
================

* Development workflow examples from AstroPy: https://astropy.readthedocs.org/en/latest/development/workflow/development_workflow.html
* GIT tutorial: https://www.atlassian.com/git/tutorials/syncing/git-pull
* Code distribution and Packaging https://packaging.python.org/en/latest/




0 comments on commit a99555b

Please sign in to comment.