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 MkDocs to generate documentation #705

Merged
merged 13 commits into from
Aug 8, 2024
Merged
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
20 changes: 0 additions & 20 deletions .github/workflows/dependencies/documentation.sh

This file was deleted.

5 changes: 2 additions & 3 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,8 @@ jobs:

- name: Dependencies
run: |
.github/workflows/dependencies/documentation.sh
python3 -m pip install --upgrade pip
python3 -m pip install sphinx==5.3.0 sphinx_rtd_theme sphinxcontrib_bibtex sphinx-copybutton
python3 -m pip install pypandoc_binary mkdocs-material>=9.5.9 mkdocs-include-markdown-plugin>=6.0.4 mkdocs-exclude>=1.0.2 mkdocs-macros-plugin>=1.0.4 pymdown-extensions mkdocs-awesome-pages-plugin mkdocs-material mkdocs-bibtex==2.15.0

- name: Install and Build
run: |
Expand All @@ -54,7 +53,7 @@ jobs:
--exclude=.github \
.
env:
INPUT_PATH: ./docs/_build/html
INPUT_PATH: ./docs/site

- name: Upload artifact
uses: actions/upload-artifact@main
Expand Down
6 changes: 6 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -38,11 +38,17 @@ __pycache__
# image files
*.png

/docs/site/*

# Documentation build directory
docs/api/
docs/doxyoutput/
_build/

# Include image and pdf files inside docs
!/docs/docs/flowchart-v2.pdf
!/docs/docs/tests/attach/*.png

# Kokkos build files
KokkosCore_config.h
KokkosCore_config.tmp
Expand Down
13 changes: 2 additions & 11 deletions build_docs.sh
Original file line number Diff line number Diff line change
@@ -1,16 +1,7 @@
#!/bin/bash
set -e # Exit with nonzero exit code if anything fails

# Doxygen
echo "Build the Doxygen documentation"
echo "Build the HTML documentation using MkDocs"
cd docs
doxygen &> doxygen.out
cd ../

# sphinx
cd docs

echo "Build the Sphinx documentation for Quokka."
#make PYTHON="python3" LATEXMKOPTS="-interaction=nonstopmode" latexpdf
make PYTHON="python3" html
mkdocs build
cd ../
Loading
Loading