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
31 changes: 31 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
name: Docs

# Docs build check is defined once, centrally, in PyAutoHeart's reusable
# workflow (Heart owns all health/readiness checking). This thin caller
# builds the Sphinx docs on PRs and fails on warning-count regression
# against docs/sphinx_warning_baseline.txt.

on:
push:
branches: [main]
paths:
- "docs/**"
- "autolens/**"
- "pyproject.toml"
- ".readthedocs.yaml"
- ".github/workflows/docs.yml"
pull_request:
paths:
- "docs/**"
- "autolens/**"
- "pyproject.toml"
- ".readthedocs.yaml"
- ".github/workflows/docs.yml"
workflow_dispatch:

jobs:
docs:
uses: PyAutoLabs/PyAutoHeart/.github/workflows/docs-build.yml@main
with:
package: autolens
secrets: inherit
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -66,3 +66,4 @@ docs/_templates
docs/generated
docs/api/generated
autolens_workspace_test/
docs/api/_autosummary
12 changes: 1 addition & 11 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@

numpydoc_show_class_members = False
numpydoc_show_inherited_class_members = False
nnumpydoc_class_members_toctree = True
numpydoc_class_members_toctree = True

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
Expand Down Expand Up @@ -122,18 +122,8 @@
pygments_dark_style = "monokai"
add_function_parentheses = False

html_context = {
"menu_links_name": "Repository",
"doc_path": "docs",
"github_project": "pyautolens",
"github_repo": "pyautolens",
"github_version": "master",
}
language = "en"

html_static_path = ["_static"]
html_css_files = ["pied-piper-admonition.css"]

html_theme_options = {
"light_css_variables": {
"color-brand-primary": "#7C4DFF",
Expand Down
1 change: 1 addition & 0 deletions docs/sphinx_warning_baseline.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
134
Loading