Skip to content

Commit

Permalink
extract docs dependencies, pipeline rename and clean
Browse files Browse the repository at this point in the history
  • Loading branch information
andped10 committed Jan 18, 2024
1 parent 6fb6111 commit 6658a5b
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 8 deletions.
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
#
# 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",
]

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

0 comments on commit 6658a5b

Please sign in to comment.