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.

Sign up for GitHub

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

ENH: Add documentation build GHA workflow file #57

Merged
merged 3 commits into from
Dec 5, 2024
Merged

ENH: Add documentation build GHA workflow file #57

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c444f69
ENH: Add documentation build GHA workflow file
jhlegarreta Dec 3, 2024
00d9412
BUG: Make the documentation config file `latex_preamble` be a literal
jhlegarreta Dec 5, 2024
230ba0c
BUG: Provide a class name to the `Sphinx` lexer
jhlegarreta Dec 5, 2024
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
31 changes: 31 additions & 0 deletions .github/workflows/doc_build.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
name: Build docs

on:
push:
branches:
- master
tags:
- 'v*'
pull_request:
branches:
- master

jobs:
build:

runs-on: ubuntu-latest

steps:
- name: Check out repository
uses: actions/checkout@v4
with:
fetch-depth: 0

- name: Install dependencies
run: |
python -m pip install --upgrade --user pip setuptools coverage
pip install .[doc]

- name: Build docs
run: |
make -C doc/ SPHINXOPTS="-W -v" BUILDDIR="$HOME/docs" OUTDIR="$HOME/html" html
5 changes: 2 additions & 3 deletions doc/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -223,7 +223,7 @@
#latex_use_parts = False

# Additional stuff for the LaTeX preamble.
latex_preamble = """
latex_preamble = r"""
\usepackage{amsmath}\usepackage{amsfonts}\usepackage{bm}\usepackage{morefloats}
\usepackage{enumitem} \setlistdepth{10} \renewcommand{\Re}{\ensuremath{\mathbb R}}
"""
Expand Down Expand Up @@ -259,5 +259,4 @@ def get_tokens_unprocessed(self, text):
yield index, Keyword.Pseudo, value
else:
yield index, token, value
wmql_lexer = WMQLLexer()
app.add_lexer('wmql', wmql_lexer)
app.add_lexer('wmql', WMQLLexer)
Loading