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

Docs: Fix Headings in Docs [Closes #2472] #2474

Merged
merged 9 commits into from
Nov 28, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions docs/api-reference/atmosphere/index.rst
Original file line number Diff line number Diff line change
@@ -1,15 +1,16 @@
.. _atmosphere:

==================================================
*****************************************
Atmosphere Models (`~ctapipe.atmosphere`)
==================================================
*****************************************

.. currentmodule:: ctapipe.atmosphere

Models of the atmosphere useful for transforming between *column densities*
(atmosphere depths :math:`X`, in units of mass per area) and *heights* (in distance
above sea-level units).


Reference/API
=============

Expand Down
13 changes: 5 additions & 8 deletions docs/api-reference/calib/camera.rst
Original file line number Diff line number Diff line change
@@ -1,23 +1,21 @@
.. _calib_camera:

##################
******************
Camera Calibration
##################
******************

.. currentmodule:: ctapipe.calib.camera


************
Introduction
************
============

This module contains all the methods and classes that are used to calibrate the
CTA Cameras (MC, prototypes and final camera calibration algorithms).


****************
CameraCalibrator
****************
================

The primary class in this module is the `~ctapipe.calib.camera.calibrator.CameraCalibrator`. This class handles
two data level transition stages for the event:
Expand All @@ -32,9 +30,8 @@ See the `CTA Top-Level Data Model Definitions <https://redmine.cta-observatory.o
different data levels.


*************
Reference/API
*************
=============

.. automodapi:: ctapipe.calib.camera

Expand Down
6 changes: 2 additions & 4 deletions docs/api-reference/calib/index.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
.. _calib:


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

.. currentmodule:: ctapipe.calib

Expand All @@ -28,7 +27,6 @@ Submodules
camera



Reference/API
=============

Expand Down
6 changes: 3 additions & 3 deletions docs/api-reference/containers/index.rst
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
.. _containers:

==================================
**********************************
Containers (`~ctapipe.containers`)
==================================
**********************************

.. currentmodule:: ctapipe.containers


Introduction
============

Expand All @@ -20,4 +21,3 @@ Reference/API
=============

.. automodapi:: ctapipe.containers

5 changes: 3 additions & 2 deletions docs/api-reference/coordinates/index.rst
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
.. _coordinates:

====================================
************************************
Coordinates (`~ctapipe.coordinates`)
====================================
************************************

.. currentmodule:: ctapipe.coordinates


Introduction
============

Expand Down
5 changes: 3 additions & 2 deletions docs/api-reference/core/index.rst
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
.. _core:

==================================================
**************************************************
Core Structures and Base Classes (`~ctapipe.core`)
==================================================
**************************************************

.. currentmodule:: ctapipe.core


Introduction
============

Expand Down
6 changes: 4 additions & 2 deletions docs/api-reference/core/traits.rst
Original file line number Diff line number Diff line change
@@ -1,16 +1,18 @@
.. _traits:

====================================
************************************
Traitlet Implementations for ctapipe
====================================
************************************

.. currentmodule:: ctapipe.core.traits


Introduction
============

Custom Traitlets implemented for ctapipe.


Reference/API
=============

Expand Down
11 changes: 4 additions & 7 deletions docs/api-reference/image/cleaning.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
.. _image_cleaning:

===========================
**************
Image Cleaning
===========================
**************

Cleaning/denoising of images (tailcuts cleaning, dilation,
filtering).
Expand All @@ -13,9 +13,6 @@ An example of image cleaning and dilation:


API Reference
-------------

.. automodapi:: ctapipe.image.cleaning


=============

.. automodapi:: ctapipe.image.cleaning
21 changes: 11 additions & 10 deletions docs/api-reference/image/extractor.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
.. _image_charge_extractors:


#########################################
Image Extraction (waveform cube to image)
#########################################
*****************************************
Image Extraction (Waveform Cube to Image)
*****************************************

.. currentmodule:: ctapipe.image.extractor

Expand Down Expand Up @@ -33,9 +32,8 @@ signal contained in the waveform with two parameters:
* The position (time) of the signal with the waveform.


************************
Image Extraction Methods
************************
========================

The field of signal processing is very widespread, and many common
techniques are applicable to the waveforms from Cherenkov cameras. The large
Expand All @@ -62,9 +60,8 @@ another.
See below for the currently existing `ImageExtractor` classes.


***********************
Units and Normalisation
***********************
=======================

An `ImageExtractor` should preserve the units of the waveform samples when
extracting the charge. I.e. if the samples are already calibrated into
Expand All @@ -78,9 +75,10 @@ the result of the `ImageExtractor` will equal 1, no matter the window size.
The extracted pulse time is corrected for the waveform sampling rate to be
provided in units of nanoseconds.

********

Examples
********
========


TwoPassWindowSum
----------------
Expand All @@ -90,4 +88,7 @@ Example of 1st pass integration:
.. image:: ./TwoPassWindowSum_1st_pass_example.png


Reference/API
=============

.. automodapi:: ctapipe.image.extractor
8 changes: 5 additions & 3 deletions docs/api-reference/image/hillas.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
.. _image_hillas:

=======================
***********************
Hillas Parameterization
=======================
***********************


.. automodapi:: ctapipe.image.hillas
Reference/API
=============

.. automodapi:: ctapipe.image.hillas
6 changes: 2 additions & 4 deletions docs/api-reference/image/index.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
.. _image:

==========================
**************************
Imaging (`~ctapipe.image`)
==========================
**************************

.. currentmodule:: ctapipe.image

Expand Down Expand Up @@ -31,10 +31,8 @@ This module contains the following sub-modules, but the most important functions
invalid_pixels



Reference/API
=============


.. automodapi:: ctapipe.image
:no-inheritance-diagram:
9 changes: 4 additions & 5 deletions docs/api-reference/image/invalid_pixels.rst
Original file line number Diff line number Diff line change
@@ -1,12 +1,11 @@
.. _invalid_pixels:

=======================
***********************
Invalid Pixels Handling
=======================
***********************



API Reference
-------------
Reference/API
=============

.. automodapi:: ctapipe.image.invalid_pixels
11 changes: 5 additions & 6 deletions docs/api-reference/image/modifications.rst
Original file line number Diff line number Diff line change
@@ -1,12 +1,11 @@
.. _image_modifications:

===========================
*******************
Image Modifications
===========================


.. automodapi:: ctapipe.image.modifications

*******************


Reference/API
=============

.. automodapi:: ctapipe.image.modifications
10 changes: 7 additions & 3 deletions docs/api-reference/image/muon.rst
Original file line number Diff line number Diff line change
@@ -1,11 +1,15 @@
.. _image_muon:

====================
Muon image analysis
====================
*******************
Muon Image Analysis
*******************

Algorithms for detecting and characterizing muon images


Reference/API
=============

.. automodapi:: ctapipe.image.muon

.. automodapi:: ctapipe.image.muon.processor
Expand Down
10 changes: 6 additions & 4 deletions docs/api-reference/image/pixel_likelihood.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
.. _image_pixel_likelihood:

============================
Pixel likelihood calculation
============================
****************************
Pixel Likelihood Calculation
****************************


.. automodapi:: ctapipe.image.pixel_likelihood
Reference/API
=============

.. automodapi:: ctapipe.image.pixel_likelihood
12 changes: 5 additions & 7 deletions docs/api-reference/image/reducers.rst
Original file line number Diff line number Diff line change
@@ -1,15 +1,13 @@
.. _image_reducers:

======================
Image volume reduction
======================
**********************
Image Volume Reduction
**********************

Algorithms for reducing image size via volume selection and other methods.


API Reference
-------------
Reference/API
=============

.. automodapi:: ctapipe.image.reducer


13 changes: 8 additions & 5 deletions docs/api-reference/image/toymodel.rst
Original file line number Diff line number Diff line change
@@ -1,10 +1,13 @@
.. _image_toymodel:

==========================
Toy model image generation
==========================
**************************
Toy Model Image Generation
**************************

fake shower image generation for testing purposes
Fake shower image generation for testing purposes.

.. automodapi:: ctapipe.image.toymodel

Reference/API
=============

.. automodapi:: ctapipe.image.toymodel
3 changes: 2 additions & 1 deletion docs/api-reference/index.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
********
API Docs
=====================
********

.. toctree::
:maxdepth: 1
Expand Down
4 changes: 3 additions & 1 deletion docs/api-reference/instrument/camera.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,10 @@

.. currentmodule:: ctapipe.instrument


******************
Camera Description
==================
******************

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