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

Remove duplicate doc build, doc config clean ups #604

Merged
merged 6 commits into from
Dec 5, 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
5 changes: 0 additions & 5 deletions .github/workflows/ci_tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -58,11 +58,6 @@ jobs:
python: '3.11'
toxenv: py11-test-devdeps

- name: Test building of Sphinx docs
os: ubuntu-latest
python: 3.x
toxenv: build_docs

steps:
- name: Checkout code
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
Expand Down
Empty file removed .gitmodules
Empty file.
26 changes: 26 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
version: 2

build:
os: "ubuntu-22.04"
apt_packages:
- graphviz
tools:
python: "3.11"

sphinx:
builder: html
configuration: docs/conf.py
fail_on_warning: true

# Install regular dependencies.
# Then, install special pinning for RTD.
python:
install:
- method: pip
path: .
extra_requirements:
- docs

# Optionally build your docs in additional formats such as PDF
formats:
- pdf
31 changes: 0 additions & 31 deletions .readthedocs.yml

This file was deleted.

6 changes: 1 addition & 5 deletions MANIFEST.in
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,11 @@ include LICENSE.rst
include README.rst
include CHANGES.rst

include ez_setup.py
include ah_bootstrap.py
include pyproject.toml
include setup.cfg

recursive-include *.pyx *.c *.pxd
recursive-include docs *
recursive-include licenses *
recursive-include cextern *
recursive-include scripts *

prune build
prune docs/_build
Expand Down
9 changes: 1 addition & 8 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -64,12 +64,6 @@
copyright = '{0}, {1}'.format(
datetime.datetime.now().year, setup_cfg['author'])

# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
__import__(project)
package = sys.modules[project]

# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
Expand Down Expand Up @@ -166,8 +160,7 @@
]

# -- Resolving issue number to links in changelog -----------------------------
github_issues_url = 'https://github.com/{0}/issues/'.format(setup_cfg['github_p\
roject'])
github_issues_url = 'https://github.com/astropy/astroplan/issues/'

# -- Options for linkcheck output -------------------------------------------
linkcheck_retry = 5
Expand Down
7 changes: 0 additions & 7 deletions docs/rtd-pip-requirements

This file was deleted.

Loading