UPpdated documentation

.flake8

@@ -5,3 +5,4 @@ max-line-length = 80
 max-complexity = 10
 docstring-convention = google
 per-file-ignores = tests/*:S101
+rst-roles = cite,class,const,func,meth,mod,ref

README.rst

@@ -48,7 +48,7 @@ Requirements
 Installation
 ------------
 
-You can install *Ussa1976* via pip_ from PyPI_:
+You can install *USSA1976* via pip_ from PyPI_:
 
 .. code:: console
 
@@ -72,7 +72,7 @@ License
 -------
 
 Distributed under the terms of the `MIT license`_,
-*Ussa1976* is free and open source software.
+*USSA1976* is free and open source software.
 
 
 Issues

docs/bibliography.bib

@@ -0,0 +1,11 @@
+@techreport{NASA1976USStandardAtmosphere,
+ author = {NASA and NOAA and USAF},
+ title = {{U.S. Standard Atmosphere}, 1976},
+ type = {techreport},
+ institution = {National Aeronautics and Space Administration},
+ year = {1976},
+ number = {NASA-TM-X-74335},
+ url = {https://ntrs.nasa.gov/search.jsp?R=19770009539},
+ urldate = {2019-10-25},
+ shorttitle = {US76}
+}

docs/bibliography.rst

@@ -0,0 +1,7 @@
+.. only:: html or text
+
+ Bibliography
+ ============
+
+.. bibliography::
+ :cited:

docs/conf.py

@@ -2,14 +2,22 @@
 from datetime import datetime
 
 
-project = "Ussa1976"
+project = "USSA1976"
 author = "Yvan Nollet"
 copyright = f"{datetime.now().year}, {author}"
 extensions = [
  "sphinx.ext.autodoc",
+ "sphinx.ext.intersphinx",
  "sphinx.ext.napoleon",
  "sphinx_click",
- "sphinx_rtd_theme",
+ "sphinxcontrib.bibtex",
 ]
 autodoc_typehints = "description"
-html_theme = "sphinx_rtd_theme"
+bibtex_bibfiles = ["bibliography.bib"]
+html_theme = "furo"
+intersphinx_mapping = {
+ "numpy": ("https://numpy.org/doc/stable/", None),
+ "scipy": ("http://docs.scipy.org/doc/scipy/reference/", None),
+ "pint": ("https://pint.readthedocs.io/en/stable/", None),
+ "xarray": ("http://xarray.pydata.org/en/stable/", None),
+}

docs/index.rst

@@ -9,6 +9,7 @@
  :maxdepth: 1
 
  usage
+ bibliography
  reference
  contributing
  Code of Conduct <codeofconduct>

mypy.ini

@@ -17,4 +17,4 @@ warn_redundant_casts = True
 warn_return_any = True
 warn_unreachable = True
 warn_unused_configs = True
-warn_unused_ignores = True
+warn_unused_ignores = False

noxfile.py

@@ -164,7 +164,7 @@ def docs_build(session: Session) -> None:
  """Build the documentation."""
  args = session.posargs or ["docs", "docs/_build"]
  session.install(".")
- session.install("sphinx", "sphinx-click", "sphinx-rtd-theme")
+ session.install("sphinx", "sphinx-click", "sphinxcontrib_bibtex", "furo")
 
  build_dir = Path("docs", "_build")
  if build_dir.exists():
@@ -178,7 +178,9 @@ def docs(session: Session) -> None:
  """Build and serve the documentation with live reloading on file changes."""
  args = session.posargs or ["--open-browser", "docs", "docs/_build"]
  session.install(".")
- session.install("sphinx", "sphinx-autobuild", "sphinx-click", "sphinx-rtd-theme")
+ session.install(
+ "sphinx", "sphinx-autobuild", "sphinxcontrib_bibtex", "sphinx-click", "furo"
+ )
 
  build_dir = Path("docs", "_build")
  if build_dir.exists():