Skip to content

Commit

Permalink
DOC: Auto-generate Pydantic model documentation
Browse files Browse the repository at this point in the history
This implements a fork/copy of autosummary, stored internally, to
generate hierarchically structured documentation for the Pydantic model
that represents the metadata.
  • Loading branch information
mferrera committed Jun 25, 2024
1 parent d072a18 commit cdbe036
Show file tree
Hide file tree
Showing 28 changed files with 2,459 additions and 1,011 deletions.
16 changes: 9 additions & 7 deletions .github/workflows/fmudataio-documention.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,16 +17,18 @@ jobs:
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: "3.10"
python-version: "3.11"

- name: Install and build docs
- name: Install fmu-dataio
run: |
pip install pip -U && pip install wheel -U
pip install -U pip
pip install .[docs]
pip install xtgeo
pip install git+https://github.com/equinor/fmu-config
sh examples/run_examples.sh
sphinx-build -b html docs build/docs/html
- name: Generate examples
run: sh examples/run_examples.sh

- name: Build documentation
run: sphinx-build -b html docs/src build/docs/html

- name: Update GitHub pages
if: github.repository_owner == 'equinor' && github.ref == 'refs/heads/main'
Expand Down
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,8 @@ coverage.xml

# Sphinx documentation
docs/_build/
docs/apiref/
docs/src/apiref/
docs/src/datamodel/model

# PyBuilder
target/
Expand Down
2 changes: 1 addition & 1 deletion .readthedocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ version: 2
build:
os: "ubuntu-22.04"
tools:
python: "3.10"
python: "3.11"
jobs:
post_install:
- bash examples/run_examples.sh
Expand Down
2 changes: 0 additions & 2 deletions docs/contributing.rst

This file was deleted.

707 changes: 0 additions & 707 deletions docs/datamodel.rst

This file was deleted.

223 changes: 0 additions & 223 deletions docs/datastructure.rst

This file was deleted.

Loading

0 comments on commit cdbe036

Please sign in to comment.