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/**"
- "autogalaxy/**"
- "pyproject.toml"
- ".readthedocs.yaml"
- ".github/workflows/docs.yml"
pull_request:
paths:
- "docs/**"
- "autogalaxy/**"
- "pyproject.toml"
- ".readthedocs.yaml"
- ".github/workflows/docs.yml"
workflow_dispatch:

jobs:
docs:
uses: PyAutoLabs/PyAutoHeart/.github/workflows/docs-build.yml@main
with:
package: autogalaxy
secrets: inherit
5 changes: 5 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -40,3 +40,8 @@ test_autogalaxy/unit/pipeline/files/plot/PlotterInterface/inversion/fits/reconst
test_autogalaxy/unit/data_temp/simulate_and_fit/image.fits
test_autogalaxy/unit/data_temp/simulate_and_fit/noise_map.fits
test_autogalaxy/unit/data_temp/simulate_and_fit/psf.fits

# Sphinx build artifacts (generated at docs build time, never committed)
docs/_build
docs/api/generated
docs/api/_autosummary
7 changes: 0 additions & 7 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -122,13 +122,6 @@
# pygments_dark_style = "monokai"
add_function_parentheses = False

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

from sphinx.builders.html import StandaloneHTMLBuilder
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 @@
105
17 changes: 0 additions & 17 deletions readthedocs.yaml

This file was deleted.

Loading