Skip to content

Commit 0968b73

Browse files
authored
Remove duplicate doc build, doc config clean ups (#604)
* Modernize RTD config * Delete .gitmodules * Update MANIFEST.in * Delete docs/rtd-pip-requirements * Update conf.py * Remove build_docs from ci_tests.yml
1 parent ab94a9b commit 0968b73

File tree

7 files changed

+28
-56
lines changed

7 files changed

+28
-56
lines changed

.github/workflows/ci_tests.yml

-5
Original file line numberDiff line numberDiff line change
@@ -58,11 +58,6 @@ jobs:
5858
python: '3.11'
5959
toxenv: py11-test-devdeps
6060

61-
- name: Test building of Sphinx docs
62-
os: ubuntu-latest
63-
python: 3.x
64-
toxenv: build_docs
65-
6661
steps:
6762
- name: Checkout code
6863
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2

.gitmodules

Whitespace-only changes.

.readthedocs.yaml

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
version: 2
2+
3+
build:
4+
os: "ubuntu-22.04"
5+
apt_packages:
6+
- graphviz
7+
tools:
8+
python: "3.11"
9+
10+
sphinx:
11+
builder: html
12+
configuration: docs/conf.py
13+
fail_on_warning: true
14+
15+
# Install regular dependencies.
16+
# Then, install special pinning for RTD.
17+
python:
18+
install:
19+
- method: pip
20+
path: .
21+
extra_requirements:
22+
- docs
23+
24+
# Optionally build your docs in additional formats such as PDF
25+
formats:
26+
- pdf

.readthedocs.yml

-31
This file was deleted.

MANIFEST.in

+1-5
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,11 @@ include LICENSE.rst
22
include README.rst
33
include CHANGES.rst
44

5-
include ez_setup.py
6-
include ah_bootstrap.py
5+
include pyproject.toml
76
include setup.cfg
87

9-
recursive-include *.pyx *.c *.pxd
108
recursive-include docs *
119
recursive-include licenses *
12-
recursive-include cextern *
13-
recursive-include scripts *
1410

1511
prune build
1612
prune docs/_build

docs/conf.py

+1-8
Original file line numberDiff line numberDiff line change
@@ -64,12 +64,6 @@
6464
copyright = '{0}, {1}'.format(
6565
datetime.datetime.now().year, setup_cfg['author'])
6666

67-
# The version info for the project you're documenting, acts as replacement for
68-
# |version| and |release|, also used in various other places throughout the
69-
# built documents.
70-
__import__(project)
71-
package = sys.modules[project]
72-
7367
# The version info for the project you're documenting, acts as replacement for
7468
# |version| and |release|, also used in various other places throughout the
7569
# built documents.
@@ -166,8 +160,7 @@
166160
]
167161

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

172165
# -- Options for linkcheck output -------------------------------------------
173166
linkcheck_retry = 5

docs/rtd-pip-requirements

-7
This file was deleted.

0 commit comments

Comments
 (0)