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

change destination_dir #17

Merged
merged 20 commits into from
Oct 17, 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
28 changes: 8 additions & 20 deletions .github/workflows/ci.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -113,40 +113,28 @@ jobs:
curl -sSL https://install.python-poetry.org | python3 -
export PATH="$HOME/.local/bin:$PATH"

# Install project with dev dependencies
# Install project dependencies, including dev dependencies
- name: Install project with dev dependencies
run: |
poetry install --with dev

# Generate Sphinx Documentation
- name: Generate API Documentation with Sphinx
run: |
poetry run sphinx-apidoc -o docs/source codes
poetry run sphinx-apidoc -o docs/ codes

# Build HTML using Sphinx
- name: Build HTML with Sphinx
run: |
poetry run sphinx-build -b html docs/source docs/_build
poetry run sphinx-build -b html docs/ docs/_build

# Copy custom HTML files to a temporary folder
- name: Copy custom HTML files
run: |
cp -r docs/custom_html/ site-root/

# Deploy both custom HTML files and Sphinx API docs to GitHub Pages
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: site-root
destination_dir: .
publish_branch: gh-pages

# Deploy Sphinx API documentation to a subfolder on gh-pages
- name: Deploy Sphinx API docs to /api-docs
# Deploy Sphinx API documentation to gh-pages
- name: Deploy Sphinx API docs to gh-pages
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: docs/_build/html
destination_dir: ./api-docs
publish_branch: gh-pages
user_name: "GitHub Actions"
user_email: "actions@github.com"

5 changes: 4 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -31,4 +31,7 @@ data.hdf5
dont_need.html
elements.html
generic.html
images/
images/
docs/_build/
.doctrees/
docs/docs/
4 changes: 2 additions & 2 deletions docs/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@
# from the environment for the first two.
SPHINXOPTS ?=
SPHINXBUILD ?= sphinx-build
SOURCEDIR = source
BUILDDIR = build
SOURCEDIR = .
BUILDDIR = _build

# Put it first so that "make" without argument is like "make help".
help:
Expand Down
85 changes: 0 additions & 85 deletions docs/TODO.md

This file was deleted.

4 changes: 0 additions & 4 deletions docs/_build/html/.buildinfo

This file was deleted.

Binary file removed docs/_build/html/.doctrees/codes.benchmark.doctree
Binary file not shown.
Binary file removed docs/_build/html/.doctrees/codes.doctree
Binary file not shown.
Binary file removed docs/_build/html/.doctrees/codes.surrogates.doctree
Binary file not shown.
Binary file removed docs/_build/html/.doctrees/codes.train.doctree
Binary file not shown.
Binary file removed docs/_build/html/.doctrees/codes.utils.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file removed docs/_build/html/.doctrees/docs/source/codes.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file removed docs/_build/html/.doctrees/environment.pickle
Binary file not shown.
Binary file removed docs/_build/html/.doctrees/index.doctree
Binary file not shown.
Binary file removed docs/_build/html/.doctrees/modules.doctree
Binary file not shown.

This file was deleted.

This file was deleted.

This file was deleted.

15 changes: 0 additions & 15 deletions docs/_build/html/_sources/docs/source/codes.benchmark.rst

This file was deleted.

16 changes: 0 additions & 16 deletions docs/_build/html/_sources/docs/source/codes.rst

This file was deleted.

14 changes: 0 additions & 14 deletions docs/_build/html/_sources/docs/source/codes.surrogates.rst

This file was deleted.

This file was deleted.

This file was deleted.

13 changes: 0 additions & 13 deletions docs/_build/html/_sources/docs/source/codes.train.rst

This file was deleted.

16 changes: 0 additions & 16 deletions docs/_build/html/_sources/docs/source/codes.train.train_fcts.rst

This file was deleted.

23 changes: 0 additions & 23 deletions docs/_build/html/_sources/docs/source/codes.utils.data_utils.rst

This file was deleted.

Loading
Loading