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

Validating pull request builds #1

Merged
merged 5 commits into from
Jun 19, 2024
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
2 changes: 2 additions & 0 deletions .github/workflows/build-artifact.yml
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,8 @@ jobs:

- name: Build Sphinx docs
run: poetry run sphinx-build -M dirhtml . _build
env:
GIT_REF: ${{ github.head_ref }}

- name: Run Vale
uses: docker://jdkato/vale
Expand Down
4 changes: 3 additions & 1 deletion conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
# For the full list of built-in configuration values, see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html

import os

# -- Project information -----------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information

Expand Down Expand Up @@ -48,7 +50,7 @@
html_title = "Business Process Manual"
html_theme_options = {
"source_repository": "https://github.com/RoboJackets/business-process-manual/",
"source_branch": "main",
"source_branch": os.environ.get("GIT_REF", "main"),
"source_directory": "/",
"footer_icons": [
{
Expand Down
4 changes: 4 additions & 0 deletions index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,10 @@

nested-directory/index

.. todolist::

.. todo:: something

Check warning on line 20 in index.rst

View workflow job for this annotation

GitHub Actions / Build Artifact / Build Artifact

TODO entry found: something


Indices and tables
==================
Expand Down
Loading