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

Dds 1473 GitHub Actions not able to generate the documentation #650

Merged
merged 26 commits into from
Sep 21, 2023
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
3 changes: 2 additions & 1 deletion .github/workflows/release-cli.yml
Original file line number Diff line number Diff line change
Expand Up @@ -132,13 +132,14 @@ jobs:
uses: matthiaszepper/sphinx-action-v4@latest
with:
container: latest
pre-build-command: "pip install ."
pre-build-command: "apt-get update && apt-get install -y gcc && pip install ."
build-command: "make html"
docs-folder: "docs/"
- name: Build the pdf with Sphinx
uses: matthiaszepper/sphinx-action-v4@pdflatex
with:
container: pdflatex
pre-build-command: "apt-get update && apt-get install -y librsvg2-bin"
i-oden marked this conversation as resolved.
Show resolved Hide resolved
build-command: "make latexpdf"
docs-folder: "docs/"
- name: Create an artifact of the previously built HTML
Expand Down
4 changes: 4 additions & 0 deletions SPRINTLOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -297,3 +297,7 @@ _Nothing merged in CLI during this sprint_

- Updated command: `dds stats` prints tables with stats collected from API ([#643](https://github.com/ScilifelabDataCentre/dds_cli/pull/643))
- Dependency: Bump `requests` to 2.31.0 ([#649](https://github.com/ScilifelabDataCentre/dds_cli/pull/649))

# 2023-09-04 - 2023-09-15

- GitHub Actions to generate the documentation fixed ([#1473])(https://scilifelab.atlassian.net/jira/software/projects/DDS/boards/13?selectedIssue=DDS-1473)
4 changes: 3 additions & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,11 @@
#
import os
import sys
from dds_cli.version import __version__

sys.path.insert(0, os.path.abspath(".."))

from dds_cli.version import __version__
i-oden marked this conversation as resolved.
Show resolved Hide resolved


# -- Project information -----------------------------------------------------

Expand All @@ -34,6 +35,7 @@
"sphinx.ext.duration",
"sphinx.ext.autosummary",
"sphinx_copybutton",
"sphinxcontrib.rsvgconverter",
]

# Add any paths that contain templates here, relative to this directory.
Expand Down
3 changes: 2 additions & 1 deletion requirements-dev.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,5 @@ sphinx-rtd-theme==1.0.0
sphinx-click==4.0.0
pyinstaller==4.1
pylint==2.17.3
sphinx-copybutton==0.5.1
sphinx-copybutton==0.5.1
sphinxcontrib-svg2pdfconverter==1.2.2
Loading