doc astropystyle

docs/requirements.txt

@@ -1,5 +1,5 @@
 ipykernel
 ipython
 Sphinx
-sphinx-rtd-theme
+astropy-sphinx-theme
 nbsphinx

docs/source/conf.py

@@ -74,7 +74,19 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'sphinx_rtd_theme'
+html_theme = 'bootstrap-astropy'
+
+html_logo = "_static/logo.png"
+
+
+html_theme_options = {
+    'logotext1': 'Nirdust',  # white,  semi-bold
+    'logotext2': '',  # orange, light
+    'logotext3': ':docs',   # white,  light
+    'astropy_project_menubar': False
+    }
+
+
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,

docs/source/index.rst

@@ -3,14 +3,11 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Nirdust documentation!
+Nirdust
 ========================
 
 .. only:: html
 
-    .. image:: _static/logo.png
-        :align: center
-        :scale: 50 %
 
 .. image:: https://badge.fury.io/py/nirdust.svg
     :target: https://badge.fury.io/py/nirdust
@@ -19,28 +16,28 @@ Nirdust documentation!
 .. image:: https://travis-ci.com/Gaiana/nirdust.svg?branch=main
     :target: https://travis-ci.com/github/Gaiana/nirdust
     :alt: Build Status
-    
-    
+
+
 .. image:: https://github.com/Gaiana/nirdust/actions/workflows/nirdust_ci.yml/badge.svg
     :target: https://github.com/Gaiana/nirdust/actions/workflows/nirdust_ci.yml
     :alt: Build Status
-    
+
 .. image:: https://readthedocs.org/projects/nirdust/badge/?version=latest
    :target: https://nirdust.readthedocs.io/en/latest/?badge=latest
    :alt: Documentation Status
 
 .. image:: https://img.shields.io/badge/DiSoftCompCi-FAMAF-ffda00
    :target: https://github.com/leliel12/diseno_sci_sfw
    :alt: Curso doctoral FAMAF: Diseño de software para cómputo científico
-   
+
 .. image:: https://coveralls.io/repos/github/Gaiana/nirdust/badge.svg?branch=main
    :target: https://coveralls.io/github/Gaiana/nirdust?branch=main
    :alt: Coverage
-   
+
 .. image:: https://img.shields.io/badge/python-3.8+-blue.svg
    :target: https://badge.fury.io/py/uttrs
    :alt: Python 3.8+
-   
+
 .. image:: https://img.shields.io/badge/License-MIT-blue.svg
    :target: https://tldrlegal.com/license/mit-license
    :alt: License
@@ -50,26 +47,26 @@ Nirdust documentation!
 Motivation
 ----------
 
-K-band nuclear spectral continuum of Type 2 AGNs is often composed of two 
+K-band nuclear spectral continuum of Type 2 AGNs is often composed of two
 components: the stellar population emission and a hot 800 - 1600 K dust component.
 Via substraction of the stellar emission dust component fitting can be performed
 to map its prescence and estimate its temperature.
 
 Features
 --------
 
-The package uses the modeling features of astropy to fit the hot dust component 
+The package uses the modeling features of astropy to fit the hot dust component
 of a AGN K-band spectrum with black body functions. And provide a class with
-methods for spectrum manipulation and normalized-blackbody-fitting. Because 
-Nirdust normalizes the spectra before fitting, is not necessary to 
-flux-calibrate spectra to use it. 
+methods for spectrum manipulation and normalized-blackbody-fitting. Because
+Nirdust normalizes the spectra before fitting, is not necessary to
+flux-calibrate spectra to use it.
 
-Nirdust needs a minimum of two spectra to run: a nuclear one, where the dust 
-temperature will be determined, and an off-nuclear spectrum, where the emission 
+Nirdust needs a minimum of two spectra to run: a nuclear one, where the dust
+temperature will be determined, and an off-nuclear spectrum, where the emission
 is considered to be purely stellar. The off-nuclear spectrum will be used by
-Nirdust to subtract the stellar emission from the nuclear spectrum. 
+Nirdust to subtract the stellar emission from the nuclear spectrum.
 
-Footnote: the hot dust component may or may not be present in your type 2 
+Footnote: the hot dust component may or may not be present in your type 2
 nuclei, do not get disappointed if Nirdust finds nothing.