Skip to content
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
22 changes: 5 additions & 17 deletions .github/workflows/build_docs.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Build docs (html/pdf)
name: Test build of html and latex documentation

# will run in root folder devops/devops/
# and we will create the following (which will persist until next run):
Expand Down Expand Up @@ -98,26 +98,14 @@ jobs:
working-directory: docs
run: |
sphinx-build -b html source build/html
# then copy over the plugins.json from psychopy/plugins repo
curl -LO https://github.com/psychopy/plugins/raw/refs/heads/main/plugins.json
cp plugins.json build/html

- name: Sphinx build latex
working-directory: docs
run: |
sphinx-build -b latex source build/latex

- name: latex2pdf
id: compile-latex-document
uses: thomas-chauvet/latex2pdf-action@v2
- name: Upload html docs as artifact
uses: actions/upload-artifact@v6
with:
output_dir: docs/build
main_latex_file: docs/build/latex/PsychopyManual.tex
ctan_packages: amsmath amsfonts lua-uni-algos

- name: Copy pdf to html folder
working-directory: docs/build/latex
run: |
echo "PDF created"
cp PsychopyManual.pdf ../html/PsychoPyManual.pdf # note the change to capital P!
echo "PDF copied to html folder"
name: psychopy-docs-html
path: docs/build/html
Binary file modified source/_static/favicon.ico
Binary file not shown.
5 changes: 3 additions & 2 deletions source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
import sys
import pathlib
import json
import psychopy

docs_folder = pathlib.Path(__file__).parent.parent
extensions_folder = docs_folder / "extensions"
Expand Down Expand Up @@ -90,7 +91,7 @@
# built documents.
#
# The short X.Y version.
release = (docs_folder.parent/'psychopy/VERSION').open('r').read().strip() # the full version e.g. 2022.1.0.rc2
release = psychopy.__version__
version = '.'.join(release.split('.')[0:2]) # the major/mid version e.g 2022.1

# The language for content autogenerated by Sphinx. Refer to documentation
Expand Down Expand Up @@ -167,7 +168,7 @@
# The name of an image file (within the static path) to use as favicon of the
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
html_favicon = '_static/favicon.png'
html_favicon = '_static/favicon.ico'

# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
Expand Down
Loading