Skip to content

Commit

Permalink
Added IH article to doc
Browse files Browse the repository at this point in the history
  • Loading branch information
operdeck committed Jan 4, 2025
1 parent 5f6a5c6 commit eab13ef
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 3 deletions.
2 changes: 1 addition & 1 deletion python/docs/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ help:

%: Makefile
mkdir -p source/articles
cp ../../examples/datamart/Example_ADM_Analysis.ipynb ../../examples/valuefinder/* ../../examples/adm/AGBModelVisualisation.ipynb ../../examples/adm/ADMBinningInsights.ipynb ../../examples/articles/*.ipynb ../../examples/explainability_extract/explainability_extract.ipynb source/articles
cp ../../examples/datamart/Example_ADM_Analysis.ipynb ../../examples/ih/Example_IH_Analysis.ipynb ../../examples/valuefinder/* ../../examples/adm/AGBModelVisualisation.ipynb ../../examples/adm/ADMBinningInsights.ipynb ../../examples/articles/*.ipynb ../../examples/explainability_extract/explainability_extract.ipynb source/articles
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
rm -rf source/articles/output
rm source/articles/*
15 changes: 13 additions & 2 deletions python/docs/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Python documentation

The python documentation is quite straightforward. It uses Sphinx to generate the docs, nbsphinx to convert the jupyter notebooks to markdown, and Furo as the Sphinx template.
The python documentation uses *Sphinx* to generate the docs, *nbsphinx* to convert the jupyter notebooks to markdown, and *Furo* as the Sphinx template.

These requirements are included in the docs-requirements.txt file. By installing it (`pip install -r docs-requirements.txt`) you should be able to generate the docs. This is provided you have Pandoc installed, which is not a pip package so can't be included in there.
These requirements are included in the docs-requirements.txt file. By installing it (`uv pip install -r docs-requirements.txt`) you should be able to generate the docs. This is provided you have *Pandoc* installed, which is not a pip package so can't be included in there, you need to install that seperately.

Building the docs is done through the Makefile: it
- First moves the example files into the docs folder,
Expand All @@ -12,6 +12,17 @@ Building the docs is done through the Makefile: it
- Moves the docs into the top-level docs folder
- And finally removes the buildinfo so we do a clean build every time

## Creating locally

To generate a new version of the docs, simply navigate to the top-level folder and run the following command:

`(cd python/docs && make html)`

## To add new content:

1. Copy the notebooks/articles by editing the Makefile
2. Include the new article via the index.rst file in the docs/source folder




1 change: 1 addition & 0 deletions python/docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ Welcome to the PDS Tools Python documentation
:caption: Examples

articles/Example_ADM_Analysis
articles/Example_IH_Analysis
articles/ADMBinningInsights
articles/AGBModelVisualisation
articles/vf_analysis
Expand Down

0 comments on commit eab13ef

Please sign in to comment.