Skip to content

Commit 96e0f88

Browse files
Add Read the Docs configuration and update documentation requirements
1 parent 2663525 commit 96e0f88

File tree

3 files changed

+37
-14
lines changed

3 files changed

+37
-14
lines changed

.readthedocs.yml

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# .readthedocs.yml
2+
# Read the Docs configuration file
3+
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
4+
5+
# Required
6+
version: 2
7+
8+
# Set the OS, Python version and other tools
9+
build:
10+
os: ubuntu-22.04
11+
tools:
12+
python: "3.11"
13+
14+
# Build documentation in the docs/ directory with Sphinx
15+
sphinx:
16+
configuration: docs/source/conf.py
17+
18+
# Optionally build your docs in additional formats such as PDF
19+
formats:
20+
- pdf
21+
22+
# Optionally set the version of Python and requirements required to build your docs
23+
python:
24+
install:
25+
- method: pip
26+
path: .
27+
- requirements: docs/requirements.txt

docs/requirements.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
sphinx>=5.0.0
2+
sphinx_rtd_theme>=1.0.0
3+
hdmf-docutils>=0.4.1

pyproject.toml

Lines changed: 7 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -14,13 +14,7 @@ readme = "README.md"
1414
# requires-python = ">=3.8"
1515
license = {text = "BSD-3"}
1616
classifiers = [
17-
# TODO: add classifiers before release
18-
# "Programming Language :: Python",
19-
# "Programming Language :: Python :: 3.8",
20-
# "Programming Language :: Python :: 3.9",
21-
# "Programming Language :: Python :: 3.10",
22-
# "Programming Language :: Python :: 3.11",
23-
# "Programming Language :: Python :: 3.12",
17+
"Programming Language :: Python :: 3.11",
2418
# "Development Status :: 4 - Beta",
2519
"Intended Audience :: Developers",
2620
"Intended Audience :: Science/Research",
@@ -38,13 +32,12 @@ dependencies = [
3832
"ndx-ophys-devices>=0.1.1"
3933
]
4034

41-
# TODO: add URLs before release
42-
# [project.urls]
43-
# "Homepage" = "https://github.com/organization/package"
44-
# "Documentation" = "https://package.readthedocs.io/"
45-
# "Bug Tracker" = "https://github.com/organization/package/issues"
46-
# "Discussions" = "https://github.com/organization/package/discussions"
47-
# "Changelog" = "https://github.com/organization/package/blob/main/CHANGELOG.md"
35+
[project.urls]
36+
"Homepage" = "https://github.com/CatalystNeuro/ndx-microscopy"
37+
"Documentation" = "https://ndx-microscopy.readthedocs.io/"
38+
"Bug Tracker" = "https://github.com/CatalystNeuro/ndx-microscopy/issues"
39+
"Discussions" = "https://github.com/CatalystNeuro/ndx-microscopy/discussions"
40+
"Changelog" = "https://github.com/CatalystNeuro/ndx-microscopy/blob/main/CHANGELOG.md"
4841

4942
# Include only the source code under `src/pynwb/ndx_microscopy` and the spec files under `spec`
5043
# in the wheel.

0 commit comments

Comments
 (0)