Skip to content

Commit

Permalink
Add workflow step to CI to publish HTML version of the Impatient Guide (
Browse files Browse the repository at this point in the history
fixes #1257)

Also update copyright year for guide and tweak .gitignore
  • Loading branch information
PeterC-DLS committed Jun 16, 2023
1 parent 27d9dda commit 2c7feb0
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 6 deletions.
13 changes: 10 additions & 3 deletions .github/workflows/ci.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ jobs:
run: |
make prepare
- name: Build Impatient Guid
- name: Build Impatient Guide
run: |
make impatient-guide
ls -lAFgh build/impatient-guide/build/html/index.html
Expand All @@ -87,12 +87,19 @@ jobs:
- name: Build and Commit the User Manual
if: ${{ github.event.inputs.deploy && env.python_version == env.python_deploy_version }}
uses: sphinx-notes/pages@master
uses: sphinx-notes/pages@v3
with:
# path to the conf.py directory
documentation_path: build/manual/source

- name: Deploy the User Manual
- name: Build and Commit the Impatient Guide
if: ${{ github.event.inputs.deploy && env.python_version == env.python_deploy_version }}
uses: sphinx-notes/pages@v3
with:
# path to the conf.py directory
documentation_path: build/impatient-guide

- name: Deploy both the User Manual and the Impatient Guide
if: ${{ github.event.inputs.deploy && env.python_version == env.python_deploy_version }}
uses: ad-m/github-push-action@master
with:
Expand Down
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# Hidden files
.*
!.github

# Python byte / compiled / optimized
*.py[cod]
Expand Down
7 changes: 4 additions & 3 deletions impatient-guide/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -40,17 +40,18 @@
master_doc = 'index'

# General information about the project.
year = '2022' # str(datetime.datetime.now().year)
project = u'NeXus for the Impatient'
copyright = u'2014-2016, http://nexusformat.org'
copyright = u'2014-{}, http://nexusformat.org'.format(year)

# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
version = '2016'
version = year
# The full version, including alpha/beta/rc tags.
release = '2016'
release = year

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
Expand Down

0 comments on commit 2c7feb0

Please sign in to comment.