Skip to content

GH action to build and deploy docs #71

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

Closed
wants to merge 5 commits into from
Closed
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
5 changes: 5 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@ on:
- main
release:

pull_request:
branches:
- main

jobs:
test:
runs-on: ubuntu-latest
Expand Down Expand Up @@ -37,6 +41,7 @@ jobs:
run: make -C doc/manual html

- name: Deploy
if: ${{ (github.event_name == 'push' && github.ref == 'refs/heads/main') || github.event_name == 'release' }}
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
7 changes: 5 additions & 2 deletions docs/source/conf.py → doc/manual/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,11 @@
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.

import sphinx_rtd_theme

import diffpy.labpdfproc

extensions = [
"sphinx.ext.autodoc",
"sphinx.ext.autosummary",
Expand Down Expand Up @@ -75,7 +80,6 @@
# |version| and |release|, also used in various other places throughout the
# built documents.
#
import diffpy.labpdfproc

# The short X.Y version.
version = diffpy.labpdfproc.__version__
Expand Down Expand Up @@ -107,7 +111,6 @@
# a list of builtin themes.
#
html_theme = "sphinx_rtd_theme"
import sphinx_rtd_theme

html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]

Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Empty file modified prevent_commit_to_main.sh
100644 → 100755
Empty file.
2 changes: 2 additions & 0 deletions requirements/build.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
python
setuptools
5 changes: 5 additions & 0 deletions requirements/run.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
numpy
scipy
diffpy.utils
matplotlib
bg-mpl-stylesheets