From 8521d3614c4ca3b16dc816bf98ca41bcdb8c6cbc Mon Sep 17 00:00:00 2001 From: David Hoese Date: Mon, 7 Aug 2023 08:40:07 -0500 Subject: [PATCH 1/5] Add .readthedocs.yaml --- .readthedocs.yaml | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 .readthedocs.yaml diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 00000000..0553d874 --- /dev/null +++ b/.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: docs/environment.yml + +python: + install: + - method: pip + path: . From 4ece5db62d1db9c7592b03bde95849f0616e07c1 Mon Sep 17 00:00:00 2001 From: David Hoese Date: Mon, 7 Aug 2023 09:01:53 -0500 Subject: [PATCH 2/5] Add doc environment.yaml --- doc/environment.yaml | 12 ++++++++++++ 1 file changed, 12 insertions(+) create mode 100644 doc/environment.yaml diff --git a/doc/environment.yaml b/doc/environment.yaml new file mode 100644 index 00000000..560fd065 --- /dev/null +++ b/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 From 3fa660ebf564ba77a7bdee5ff779e3c2c703b79d Mon Sep 17 00:00:00 2001 From: David Hoese Date: Mon, 7 Aug 2023 09:02:17 -0500 Subject: [PATCH 3/5] Use conda environment in RTD --- .readthedocs.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 0553d874..ce40b0fb 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -10,8 +10,8 @@ sphinx: configuration: doc/source/conf.py fail_on_warning: true -# conda: -# environment: docs/environment.yml +conda: + environment: doc/environment.yaml python: install: From 3a59f01bde0911b8be51c76ee5a6f52b89371bd0 Mon Sep 17 00:00:00 2001 From: David Hoese Date: Mon, 7 Aug 2023 09:41:46 -0500 Subject: [PATCH 4/5] Fix various documentation issues --- doc/source/conf.py | 4 ++-- doc/source/index.rst | 15 +++++---------- 2 files changed, 7 insertions(+), 12 deletions(-) diff --git a/doc/source/conf.py b/doc/source/conf.py index 4ac50638..2734b585 100644 --- a/doc/source/conf.py +++ b/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. diff --git a/doc/source/index.rst b/doc/source/index.rst index 6d73fbf8..6ae7be78 100644 --- a/doc/source/index.rst +++ b/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 `_. +`celestrak's request page `_. 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: From 7b58f8624cd254143eb53d07761fd96ac601d65c Mon Sep 17 00:00:00 2001 From: David Hoese Date: Mon, 7 Aug 2023 09:55:12 -0500 Subject: [PATCH 5/5] Add _static sphinx directory --- doc/source/_static/.gitkeep | 0 1 file changed, 0 insertions(+), 0 deletions(-) create mode 100644 doc/source/_static/.gitkeep diff --git a/doc/source/_static/.gitkeep b/doc/source/_static/.gitkeep new file mode 100644 index 00000000..e69de29b