Skip to content

Commit

Permalink
Merge pull request #169 from punch-mission/switch-docs-and-versioning
Browse files Browse the repository at this point in the history
Switch to ReadTheDocs and versioning to automatic
  • Loading branch information
jmbhughes authored Nov 1, 2024
2 parents fb0097f + 7226f3e commit 2336745
Show file tree
Hide file tree
Showing 2 changed files with 39 additions and 4 deletions.
33 changes: 33 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# .readthedocs.yaml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

# Required
version: 2

# Set the OS, Python version and other tools you might need
build:
os: ubuntu-22.04
tools:
python: "3.12"


# Build documentation in the "docs/" directory with Sphinx
sphinx:
configuration: docs/source/conf.py

# Optionally build your docs in additional formats such as PDF and ePub
formats:
- pdf
- epub

# Optional but recommended, declare the Python requirements required
# to build your documentation
# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
python:
install:
- method: pip
extra_requirements:
- all
- docs
path: .
10 changes: 6 additions & 4 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
[build-system]
requires = ["setuptools>=64", "setuptools-scm>=8", "wheel"]
build-backend = "setuptools.build_meta"

[project]
name = "solpolpy"
version = "0.3.1"
dynamic = ["version"]
authors = [
{ name="J. Marcus Hughes", email="[email protected]"},
{ name="Matthew J. West", email="[email protected]"},
Expand Down Expand Up @@ -44,9 +48,7 @@ docs = [

dev = ["solpolpy[test, docs]", "pre-commit"]

[build-system]
requires = ["setuptools>=61.0"]
build-backend = "setuptools.build_meta"
[tool.setuptools_scm]

[tool.setuptools]
packages = ['solpolpy']
Expand Down

0 comments on commit 2336745

Please sign in to comment.