Merge pull request #2474 from aknierim/fix_headings

Docs: Fix Headings in Docs [Closes #2472]
cta-observatory · Nov 28, 2023 · b175f69 · b175f69
2 parents 4a45dcd + fa945a6
commit b175f69
Show file tree

Hide file tree

Showing 55 changed files with 345 additions and 276 deletions.
diff --git a/docs/api-reference/atmosphere/index.rst b/docs/api-reference/atmosphere/index.rst
@@ -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
 =============
 

diff --git a/docs/api-reference/calib/camera.rst b/docs/api-reference/calib/camera.rst
@@ -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:
@@ -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
 

diff --git a/docs/api-reference/calib/index.rst b/docs/api-reference/calib/index.rst
@@ -1,9 +1,8 @@
 .. _calib:
 
-
-==============================
+******************************
 Calibration (`~ctapipe.calib`)
-==============================
+******************************
 
 .. currentmodule:: ctapipe.calib
 
@@ -28,7 +27,6 @@ Submodules
   camera
 
 
-
 Reference/API
 =============
 

diff --git a/docs/api-reference/containers/index.rst b/docs/api-reference/containers/index.rst
@@ -1,11 +1,12 @@
 .. _containers:
 
-==================================
+**********************************
 Containers (`~ctapipe.containers`)
-==================================
+**********************************
 
 .. currentmodule:: ctapipe.containers
 
+
 Introduction
 ============
 
@@ -20,4 +21,3 @@ Reference/API
 =============
 
 .. automodapi:: ctapipe.containers
-
diff --git a/docs/api-reference/coordinates/index.rst b/docs/api-reference/coordinates/index.rst
@@ -1,11 +1,12 @@
 .. _coordinates:
 
-====================================
+************************************
 Coordinates (`~ctapipe.coordinates`)
-====================================
+************************************
 
 .. currentmodule:: ctapipe.coordinates
 
+
 Introduction
 ============
 

diff --git a/docs/api-reference/core/index.rst b/docs/api-reference/core/index.rst
@@ -1,11 +1,12 @@
 .. _core:
 
-==================================================
+**************************************************
 Core Structures and Base Classes (`~ctapipe.core`)
-==================================================
+**************************************************
 
 .. currentmodule:: ctapipe.core
 
+
 Introduction
 ============
 

diff --git a/docs/api-reference/core/traits.rst b/docs/api-reference/core/traits.rst
@@ -1,16 +1,18 @@
 .. _traits:
 
-====================================
+************************************
 Traitlet Implementations for ctapipe
-====================================
+************************************
 
 .. currentmodule:: ctapipe.core.traits
 
+
 Introduction
 ============
 
 Custom Traitlets implemented for ctapipe.
 
+
 Reference/API
 =============
 

diff --git a/docs/api-reference/image/cleaning.rst b/docs/api-reference/image/cleaning.rst
@@ -1,8 +1,8 @@
 .. _image_cleaning:
 
-===========================
+**************
 Image Cleaning
-===========================
+**************
 
 Cleaning/denoising of images (tailcuts cleaning, dilation,
 filtering).
@@ -13,9 +13,6 @@ An example of image cleaning and dilation:
 
 
 API Reference
--------------
-
-.. automodapi:: ctapipe.image.cleaning
-
-
+=============
 
+.. automodapi:: ctapipe.image.cleaning
diff --git a/docs/api-reference/image/extractor.rst b/docs/api-reference/image/extractor.rst
@@ -1,9 +1,8 @@
 .. _image_charge_extractors:
 
-
-#########################################
-Image Extraction (waveform cube to image)
-#########################################
+*****************************************
+Image Extraction (Waveform Cube to Image)
+*****************************************
 
 .. currentmodule:: ctapipe.image.extractor
 
@@ -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
@@ -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
@@ -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
 ----------------
@@ -90,4 +88,7 @@ Example of 1st pass integration:
 .. image:: ./TwoPassWindowSum_1st_pass_example.png
 
 
+Reference/API
+=============
+
 .. automodapi:: ctapipe.image.extractor
diff --git a/docs/api-reference/image/hillas.rst b/docs/api-reference/image/hillas.rst
@@ -1,9 +1,11 @@
 .. _image_hillas:
 
-=======================
+***********************
 Hillas Parameterization
-=======================
+***********************
 
 
-.. automodapi:: ctapipe.image.hillas
+Reference/API
+=============
 
+.. automodapi:: ctapipe.image.hillas
diff --git a/docs/api-reference/image/index.rst b/docs/api-reference/image/index.rst
@@ -1,8 +1,8 @@
 .. _image:
 
-==========================
+**************************
 Imaging (`~ctapipe.image`)
-==========================
+**************************
 
 .. currentmodule:: ctapipe.image
 
@@ -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:
diff --git a/docs/api-reference/image/invalid_pixels.rst b/docs/api-reference/image/invalid_pixels.rst
@@ -1,12 +1,11 @@
 .. _invalid_pixels:
 
-=======================
+***********************
 Invalid Pixels Handling
-=======================
+***********************
 
 
-
-API Reference
--------------
+Reference/API
+=============
 
 .. automodapi:: ctapipe.image.invalid_pixels
diff --git a/docs/api-reference/image/modifications.rst b/docs/api-reference/image/modifications.rst
@@ -1,12 +1,11 @@
 .. _image_modifications:
 
-===========================
+*******************
 Image Modifications
-===========================
-
-
-.. automodapi:: ctapipe.image.modifications
-
+*******************
 
 
+Reference/API
+=============
 
+.. automodapi:: ctapipe.image.modifications
diff --git a/docs/api-reference/image/muon.rst b/docs/api-reference/image/muon.rst
@@ -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

diff --git a/docs/api-reference/image/pixel_likelihood.rst b/docs/api-reference/image/pixel_likelihood.rst
@@ -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
diff --git a/docs/api-reference/image/reducers.rst b/docs/api-reference/image/reducers.rst
@@ -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
-
-
diff --git a/docs/api-reference/image/toymodel.rst b/docs/api-reference/image/toymodel.rst
@@ -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
diff --git a/docs/api-reference/index.rst b/docs/api-reference/index.rst
@@ -1,5 +1,6 @@
+********
 API Docs
-=====================
+********
 
 .. toctree::
   :maxdepth: 1

diff --git a/docs/api-reference/instrument/camera.rst b/docs/api-reference/instrument/camera.rst
@@ -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.