Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 2 additions & 2 deletions .github/workflows/publish_doc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -44,11 +44,11 @@ jobs:
- name: Build
run: |
eval $(opam env)
make build-doc
make doc

- name: Deploy
uses: peaceiris/actions-gh-pages@v3
# if: ${{ github.ref == 'refs/heads/main' }}
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: _build/default/_doc/_html/
publish_dir: _build/default/full-doc/html/
15 changes: 1 addition & 14 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -37,18 +37,5 @@ all: FORCE quick_test tests test_dgfip_c_backend
clean: FORCE remise_a_zero_versionnage
$(call make_in,$(DGFIP_DIR),clean_backend_all)
rm -f doc/doc.html
rm -rf examples/doc
dune clean

doc-deps: FORCE
python3 -m venv .venv
.venv/bin/pip install sphinx myst-parser

sphinx-doc: FORCE
@command -v .venv/bin/sphinx-build >/dev/null 2>&1 || \
{ echo "Pour construire la documentation, vous avez besoin de sphinx-build avec \
l'extension 'myst-parser'. Lancez `make doc-deps`."; exit 1; }
rm -rf _build/default/doc/*
cp -rf doc/* _build/default/doc/
mkdir -p examples/doc
.venv/bin/sphinx-build -M html _build/default/doc/ examples/doc
.venv/bin/sphinx-build -M latexpdf _build/default/doc/ examples/doc
Binary file added doc/architecture.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
5 changes: 4 additions & 1 deletion doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,7 @@
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output

html_theme = 'alabaster'
html_static_path = ['_static']
html_static_path = ['_static','_static/dev']

# When building, we move the dev documentation in this 'dev' folder.
html_extra_path = ['_static/dev']
Loading
Loading