Skip to content

Commit

Permalink
DOC: updating tutorials
Browse files Browse the repository at this point in the history
  • Loading branch information
saullocastro committed Sep 2, 2024
1 parent ce34b98 commit 300d89c
Show file tree
Hide file tree
Showing 8 changed files with 1,607 additions and 1 deletion.
9 changes: 8 additions & 1 deletion .github/workflows/auto_doc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,23 +11,30 @@ jobs:

steps:
- uses: actions/checkout@v4

- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: '3.11'

- name: Install dependencies
run: |
sudo apt-get update
sudo apt-get install -y pandoc
python3 -m pip install --upgrade pip
python3 -m pip install --upgrade -r ci_requirements_doc.txt
- name: Install module
run: |
python3 -m pip install .
- name: Building documentation
run: |
cd doc
make html
- name: Deploying documentation
uses: JamesIves/github-pages-deploy-action@v4.3.3
uses: JamesIves/github-pages-deploy-action@v4
with:
branch: gh-pages # The branch the action should deploy to.
folder: ./doc/build/html # The folder the action should deploy.
1 change: 1 addition & 0 deletions ci_requirements_doc.txt
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,4 @@ numpy
sphinx
numpydoc
pydata-sphinx-theme
nbsphinx
2 changes: 2 additions & 0 deletions doc/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,8 @@
'sphinx.ext.autosummary',
'numpydoc',
'sphinx.ext.mathjax',
#'myst_nb',
'nbsphinx',
]

# Add any paths that contain templates here, relative to this directory.
Expand Down
8 changes: 8 additions & 0 deletions doc/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,14 @@ Bibtex :
title = {{Methods for analysis and design of composites (Version 0.7.1) [Computer software]. 2024}}
}

Tutorials
---------

.. toctree::
:maxdepth: 2

tutorials.rst


composites API
--------------
Expand Down
778 changes: 778 additions & 0 deletions doc/source/opt-lightweight-discrete-ghost-layer.ipynb

Large diffs are not rendered by default.

8 changes: 8 additions & 0 deletions doc/source/tutorials.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
=========
Tutorials
=========

.. toctree::
:maxdepth: 1

opt-lightweight-discrete-ghost-layer
File renamed without changes.
802 changes: 802 additions & 0 deletions tutorials/opt2.ipynb

Large diffs are not rendered by default.

0 comments on commit 300d89c

Please sign in to comment.