Fix docs and include new pages in it

Co-authored-by: Michele Peresano <michele.peresano@cea.fr> Co-authored-by: Lukas Nickel <lukas.nickel@tu-dortmund.de>
cta-observatory · Sep 18, 2020 · 9b448b8 · 9b448b8
1 parent 036ef64
commit 9b448b8
Show file tree

Hide file tree

Showing 9 changed files with 77 additions and 44 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -1,9 +1,9 @@
 language: generic
 
 env:
-    global:
-        - PYTHONIOENCODING=UTF8
-        - MPLBACKEND=Agg
+  global:
+    - PYTHONIOENCODING=UTF8
+    - MPLBACKEND=Agg
 
 matrix:
   include:
@@ -20,28 +20,29 @@ matrix:
         - CONDA=true
 
 before_install:
-
-    - wget https://repo.continuum.io/miniconda/Miniconda3-latest-Linux-x86_64.sh -O miniconda.sh;
-    - bash miniconda.sh -b -p $HOME/miniconda
-    - . $HOME/miniconda/etc/profile.d/conda.sh
-    - hash -r
-    - conda config --set always_yes yes --set changeps1 no
-    - conda update -q conda  # get latest conda version
-    - conda info -a # Useful for debugging any issues with conda
+  - wget https://repo.continuum.io/miniconda/Miniconda3-latest-Linux-x86_64.sh -O miniconda.sh;
+  - bash miniconda.sh -b -p $HOME/miniconda
+  - . $HOME/miniconda/etc/profile.d/conda.sh
+  - hash -r
+  - conda config --set always_yes yes --set changeps1 no
+  - conda update -q conda  # get latest conda version
+  - conda info -a # Useful for debugging any issues with conda
 
 install:
-    - conda env create -f environment.yml
-    - conda activate pyirf
-    - pip install travis-sphinx codecov pytest-cov
-    - python setup.py install
+  - sed -i -e "s/- python=.*/- python=$PYTHON_VERSION/g" environment.yml
+  - conda env create -f environment.yml
+  - conda activate pyirf-dev
+  - pip install travis-sphinx codecov pytest-cov
+  - pip install .
+  - python --version
 
 script:
-    - pytest --cov=pyirf
+  - pytest --cov=pyirf
 
 after_script:
-    - if [[ "$CONDA" == "true" ]];then
-          conda deactivate
-      fi
+  - if [[ "$CONDA" == "true" ]];then
+        conda deactivate
+    fi
 
 after_success:
-    - codecov
+  - codecov
diff --git a/docs/binning.rst b/docs/binning.rst
@@ -0,0 +1,11 @@
+.. _binning:
+
+Binning and Histogram Utilities
+===============================
+
+
+Reference/API
+-------------
+
+.. automodapi:: pyirf.binning
+   :no-inheritance-diagram:
diff --git a/docs/conf.py b/docs/conf.py
@@ -40,10 +40,9 @@
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
-    "rinoh.frontend.sphinx",
-    "sphinx_automodapi.automodapi",
-    "sphinx.ext.autodoc",
     "numpydoc",
+    "nbsphinx",
+    "sphinx.ext.autodoc",
     "sphinx.ext.doctest",
     "sphinx.ext.intersphinx",
     "sphinx.ext.todo",
@@ -55,8 +54,6 @@
     "sphinx.ext.napoleon",
     "sphinx_automodapi.automodapi",
     "sphinx_automodapi.smart_resolver",
-    "nbsphinx",
-    "IPython.sphinxext.ipython_console_highlighting",
 ]
 
 # nbsphinx
@@ -79,7 +76,7 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = "alabaster"
+html_theme = "sphinx_rtd_theme"
 
 html_theme_options = {
     "github_user": "cta-observatory",

diff --git a/docs/index.rst b/docs/index.rst
@@ -52,14 +52,24 @@ which this documentation is linked.
   :caption: Structure
   :maxdepth: 1
 
+  spectral
+  binning
   io/index
   resources/index
   perf/index
   scripts/index
 
+
+Reference/API
+-------------
+
+.. automodapi:: pyirf
+   :no-inheritance-diagram:
+
 Indices and tables
 ==================
 
 * :ref:`genindex`
 * :ref:`modindex`
 * :ref:`search`
+
diff --git a/docs/requirements.txt b/docs/requirements.txt
diff --git a/docs/spectral.rst b/docs/spectral.rst
@@ -0,0 +1,11 @@
+.. _spectral:
+
+Event Weighting and Spectrum Definitions
+========================================
+
+
+Reference/API
+-------------
+
+.. automodapi:: pyirf.spectral
+   :no-inheritance-diagram:
diff --git a/environment.yml b/environment.yml
@@ -4,6 +4,7 @@ name: pyirf-dev
 channels:
   - default
 dependencies:
+  - python=3.7
   - astropy
   - numpy
   - ipython
@@ -12,6 +13,13 @@ dependencies:
   - pytest
   - scipy
   - setuptools
+  # docs
+  - numpydoc
   - sphinx
   - sphinx_rtd_theme
   - pip
+  - pip:
+      - rinohtype
+      - nbsphinx
+      - gammapy~=0.8.0
+      - sphinx_automodapi
diff --git a/pyirf/spectral.py b/pyirf/spectral.py
@@ -135,8 +135,8 @@ def __call__(self, energy):
     e_ref=1 * u.GeV,
 )
 
-# From "Description of CTA Instrument Response Functions (Production 3b Simulation)"
-# section 4.3.1
+#: Proton spectrum definition defined in the CTA Prod3b IRF Document
+#: From "Description of CTA Instrument Response Functions (Production 3b Simulation), section 4.3.1
 IRFDOC_PROTON_SPECTRUM = PowerLaw(
     flux_normalization=9.8e-6 / (u.cm**2 * u.s * u.TeV * u.sr),
     spectral_index=-2.62,

diff --git a/setup.py b/setup.py
@@ -15,5 +15,16 @@
         "pandas",
         "scipy",
         "tables",
+        "gammapy~=0.8.0",
     ],
+    extras_require={
+        'docs': [
+            'rinohtype',
+            'sphinx',
+            'sphinx_rtd_theme',
+            'sphinx_automodapi',
+            'numpydoc',
+            'nbsphinx'
+        ]
+    }
 )