Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use sphinx-autoapi to generate API documentation #3646

Open
wants to merge 55 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
55 commits
Select commit Hold shift + click to select a range
7b712cc
add autoapi gubbins to sonf.py
valeriupredoi Jun 6, 2024
2623191
first draft of readthedocs config file for autoapi
valeriupredoi Jun 6, 2024
53e81a3
actually remove the pip bit
valeriupredoi Jun 6, 2024
fe20722
correct path to source code
valeriupredoi Jun 11, 2024
55ae5a7
try with a temporary version placeholder
valeriupredoi Jun 11, 2024
1cf623c
rm autodocsumm
valeriupredoi Jun 11, 2024
4001b3f
duh correct RTD syntax for extension
valeriupredoi Jun 11, 2024
bf35f94
add independent requirements file
valeriupredoi Jun 11, 2024
9384eb9
revert extension name
valeriupredoi Jun 11, 2024
26e6edb
call the autoapi module installation from a separate requirements file
valeriupredoi Jun 11, 2024
1b17448
add theme dep to requirements
valeriupredoi Jun 11, 2024
9e41e1b
throw some configuration at autoapi
valeriupredoi Jun 11, 2024
3cb33ef
exclude diag_scripts
valeriupredoi Jun 11, 2024
9324b25
add only select api elements to be documented
valeriupredoi Jun 11, 2024
bd12331
comment out all autodoc settings
valeriupredoi Jun 11, 2024
09b81ad
turn off generation of index.rst and set the autoapi root dir
valeriupredoi Jun 11, 2024
5b7d23d
remove that silly index.rst already!
valeriupredoi Jun 11, 2024
5eb2186
maybe we want that index.rst after all
valeriupredoi Jun 11, 2024
8a2dfa2
try shove a sys appended path for autodoc
valeriupredoi Jun 11, 2024
e75d0c3
try shove a sys appended path for autodoc
valeriupredoi Jun 11, 2024
b22ca27
fix that terrible previous commit
valeriupredoi Jun 11, 2024
f07c760
Disable autodoc and select only wanted submodules with autoapi
bouweandela Jun 12, 2024
c546796
remove autodocsumm and pydata sphinx theme dependencies
valeriupredoi Jun 12, 2024
9901882
remove autodocsumm and pydata sphinx theme dependencies
valeriupredoi Jun 12, 2024
0c0059f
add ignore to autoapi congig
valeriupredoi Jun 12, 2024
c3d14fe
correct wildcard
valeriupredoi Jun 12, 2024
3ea9878
Add __init__.py files and add __all__
bouweandela Jun 12, 2024
06b55b9
Merge branch 'use_sphinx-autoapi' of https://github.com/ESMValGroup/E…
valeriupredoi Jun 12, 2024
01fd8fc
add testkw to the ignored list
valeriupredoi Jun 12, 2024
1d2ed6b
nevermind, am stoopid
valeriupredoi Jun 12, 2024
9f18b66
add names.py to ignores
valeriupredoi Jun 12, 2024
9f85e78
reinstate names.py
valeriupredoi Jun 12, 2024
b49b34c
comment out import in sraed init
valeriupredoi Jun 12, 2024
a0584e8
comment out all imports from shared init
valeriupredoi Jun 12, 2024
e791641
reinstate some imports
valeriupredoi Jun 12, 2024
d6fce5b
Comment out ignores
bouweandela Jun 19, 2024
6392e27
Fix formatting
bouweandela Jun 19, 2024
024896a
Fix some warnings
bouweandela Jun 19, 2024
9719bca
Fix docs build
bouweandela Jun 19, 2024
f9a568f
make package level imports
valeriupredoi Jun 20, 2024
53e7f91
make package level imports
valeriupredoi Jun 20, 2024
9c57a60
make package level imports
valeriupredoi Jun 20, 2024
c6c3a3a
make package level imports
valeriupredoi Jun 20, 2024
0d4f069
make package level imports
valeriupredoi Jun 20, 2024
eea6b00
make package level imports
valeriupredoi Jun 20, 2024
a9edecb
make package level imports
valeriupredoi Jun 20, 2024
5493f41
make package level imports
valeriupredoi Jun 20, 2024
ae53507
Merge branch 'main' into use_sphinx-autoapi
valeriupredoi Jun 20, 2024
a14d7e1
Merge branch 'main' into use_sphinx-autoapi
valeriupredoi Jun 25, 2024
08a5eba
correct for souble import
valeriupredoi Jun 25, 2024
5dc083e
correct for souble import
valeriupredoi Jun 25, 2024
7408d99
couple more conflict fixing bloopers
valeriupredoi Jun 25, 2024
ac86b9e
Merge branch 'main' into use_sphinx-autoapi
valeriupredoi Jul 9, 2024
ccfde85
Merge branch 'main' into use_sphinx-autoapi
valeriupredoi Jul 9, 2024
c228572
Merge branch 'main' into use_sphinx-autoapi
valeriupredoi Sep 13, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 6 additions & 18 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9,24 +9,7 @@ version: 2
build:
os: ubuntu-22.04
tools:
# updated and deployed from Aug 1, 2023
python: "mambaforge-22.9"
jobs:
pre_create_environment:
# update mamba just in case
- mamba update --yes --quiet --name=base mamba 'zstd=1.5.2'
- mamba --version
- mamba list --name=base
post_create_environment:
- conda run -n ${CONDA_DEFAULT_ENV} mamba list
# use conda run executable wrapper to have all env variables
- conda run -n ${CONDA_DEFAULT_ENV} mamba --version
- conda run -n ${CONDA_DEFAULT_ENV} pip install . --no-deps

# Declare the requirements required to build your docs
conda:
environment:
environment.yml
python: "3.12"

# Build documentation in the doc directory with Sphinx
sphinx:
Expand All @@ -36,3 +19,8 @@ sphinx:
# If using Sphinx, optionally build your docs in additional formats such as PDF
formats:
- pdf

# Install auotoapi requirement
python:
install:
- requirements: doc/sphinx/source/requirements.txt

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

63 changes: 0 additions & 63 deletions doc/sphinx/source/api/esmvaltool.diag_scripts.mlr.rst

This file was deleted.

This file was deleted.

This file was deleted.

6 changes: 0 additions & 6 deletions doc/sphinx/source/api/esmvaltool.diag_scripts.mlr/init.rst

This file was deleted.

9 changes: 0 additions & 9 deletions doc/sphinx/source/api/esmvaltool.diag_scripts.mlr/main.rst

This file was deleted.

9 changes: 0 additions & 9 deletions doc/sphinx/source/api/esmvaltool.diag_scripts.mlr/mmm.rst

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

6 changes: 0 additions & 6 deletions doc/sphinx/source/api/esmvaltool.diag_scripts.mlr/models.rst

This file was deleted.

This file was deleted.

9 changes: 0 additions & 9 deletions doc/sphinx/source/api/esmvaltool.diag_scripts.mlr/plot.rst

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

Loading