Docs CI #46

zmoon · 2022-02-08T05:19:00Z

provide a conda env to use when working on the docs (and for CI and for RTD)
set up CI job to check the docs
fix Sphinx warnings/errors and broken links
start API docs, with sections mirroring the sections that describe the different data sources
some docs enhancements like intersphinx, napoleon type aliases, and autosectionlabel
simplify monetio/__init__.py (though it didn't help with auto API gen...)

not having good luck with autogen options, given how the top-level API is defined in the __init__.py with imports (some open Sphinx issues about this and better autosummary :recursive: )

also move get-in-touch to separate doc

Also update some that are redirecting successfully

zmoon added 13 commits February 2, 2022 11:26

Initial docs conda env

c6ebc4f

Initial Sphinx config edits

23c2222

Remove old API doc files

fd08fe6

Fix current Sphinx warnings/errors

f4743da

Document the top-level fns

e671134

wip: api docs

9c9235c

Simplify monetio __all__

38bb665

Starting API docs manually

a923984

not having good luck with autogen options, given how the top-level API is defined in the __init__.py with imports (some open Sphinx issues about this and better autosummary :recursive: )

Enhance aeronet docs

762829e

also move get-in-touch to separate doc

Start an API section for airnow

e10cc92

Start add references to the observation sections

2cf9650

Fix links so linkcheck passes

3c26d47

Also update some that are redirecting successfully

Set up workflow job to check docs build

1f3c7f3

zmoon marked this pull request as ready for review February 8, 2022 05:28

zmoon merged commit 349f981 into noaa-oar-arl:develop Feb 10, 2022

zmoon deleted the docs branch February 10, 2022 00:15

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Docs CI #46

Docs CI #46

zmoon commented Feb 8, 2022 •

edited

Docs CI #46

Docs CI #46

Conversation

zmoon commented Feb 8, 2022 • edited

zmoon commented Feb 8, 2022 •

edited