Merge pull request #132 from pytroll/doc-rtd-config

.readthedocs.yaml

@@ -0,0 +1,19 @@
+version: 2
+
+build:
+  os: "ubuntu-20.04"
+  tools:
+    python: "mambaforge-4.10"
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  configuration: doc/source/conf.py
+  fail_on_warning: true
+
+conda:
+    environment: doc/environment.yaml
+
+python:
+    install:
+        - method: pip
+          path: .

doc/environment.yaml

@@ -0,0 +1,12 @@
+name: readthedocs
+channels:
+  - conda-forge
+dependencies:
+  - python=3.11
+  - pip
+  - numpy
+  - scipy
+  - requests
+  - pytest
+  - pyproj
+  - sphinx_rtd_theme

doc/source/conf.py

@@ -29,7 +29,7 @@
 
 # Add any Sphinx extension module names here, as strings. They can be extensions
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.coverage']
+extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.coverage', 'sphinx.ext.napoleon']
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['.templates']
@@ -124,7 +124,7 @@
 # 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,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['.static']
+html_static_path = ['_static']
 
 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
 # using the given strftime format.

doc/source/index.rst

@@ -1,8 +1,3 @@
-.. pyorbital documentation master file, created by
-   sphinx-quickstart on Mon Oct  3 08:48:29 2011.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
-
 Pyorbital
 =========
 
@@ -92,10 +87,10 @@ specific TLE file is provided or if the :envvar:`TLES` environment variable is n
 
 
 TLE download and database
-~~~~~~~~~~~~~~~~~~~~~~~~~
+^^^^^^^^^^^^^^^^^^^^^^^^^
 
 The historical TLE files can be requested from
-`celestrak <https://celestrak.com/NORAD/archives/request.php>`_.
+`celestrak's request page <https://celestrak.com/NORAD/archives/request.php>`_.
 
 There is also a script, ``fetch_tles.py``, that can be used to collect
 TLE data from several locations. The currently supported locations
@@ -197,21 +192,21 @@ API
 ---
 
 Orbital computations
-~~~~~~~~~~~~~~~~~~~~
+^^^^^^^^^^^^^^^^^^^^
 
 .. automodule:: pyorbital.orbital
    :members:
    :undoc-members:
 
 TLE handling
-~~~~~~~~~~~~
+^^^^^^^^^^^^
 
 .. automodule:: pyorbital.tlefile
    :members:
    :undoc-members:
 
 Astronomical computations
-~~~~~~~~~~~~~~~~~~~~~~~~~
+^^^^^^^^^^^^^^^^^^^^^^^^^
 
 .. automodule:: pyorbital.astronomy
    :members: