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

Cleaning docs building #68

Merged
merged 2 commits into from
Jan 31, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
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
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
# This pipeline
# - build html documentation
# - deploy html documentation to gh-pages branch of the same repository
# This pipeline
# - build developer documentation
# - push documentation to gh-pages branch of the same repository
#
andped10 marked this conversation as resolved.
Show resolved Hide resolved
# Deployment is handled by pages-build-deployment bot

name: Build and Deploy Documentation
name: Build Documentation and Push to gh-pages Branch

# Controls when the workflow will run
on:
Expand Down Expand Up @@ -33,7 +35,7 @@ jobs:
- name: Install Pandoc, EasyReflectometry and dependencies
run: |
sudo apt install pandoc
pip install . '.[dev]'
pip install . '.[docs]'
- name: Build and Commit
uses: sphinx-notes/pages@master
with:
Expand Down
8 changes: 5 additions & 3 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -42,15 +42,17 @@ dev = [
"ipykernel",
"jupyter>=1.0.0",
"jupyterlab",
"nbsphinx",
"plopp",
"pytest>=5.2",
"pytest-cov>=3.0.0",
"sphinx_book_theme",
"sphinx_autodoc_typehints",
"toml>=0.10",
"yapf>=0.31.0",
]
docs = [
"nbsphinx",
"sphinx_book_theme",
"sphinx_autodoc_typehints",
]
andped10 marked this conversation as resolved.
Show resolved Hide resolved

[project.urls]
homepage = "https://docs.easyreflectometry.org"
Expand Down
Loading