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.

Sign up for GitHub

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

Host docs to readthedocs #14

Merged
merged 13 commits into from
Jun 25, 2024
Merged

Host docs to readthedocs #14

Changes from 1 commit
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
767c02f
#10 Add initial `.readthedocs.yaml`
arjxn-py Jun 25, 2024
d06ec13
#10 configure dependencies in `readthedocs`
arjxn-py Jun 25, 2024
2097148
#10 Fix python configuration
arjxn-py Jun 25, 2024
a04a1b7
configure `readthedocs`
arjxn-py Jun 25, 2024
909c9e8
Fix configuration `readthedocs`
arjxn-py Jun 25, 2024
15c7762
Fix configuration `readthedocs`
arjxn-py Jun 25, 2024
7be588d
Remove `image` key
arjxn-py Jun 25, 2024
3f076d4
install `myst-parser`
arjxn-py Jun 25, 2024
ed8925c
Specify deps in `docs` extra instead
arjxn-py Jun 25, 2024
6278145
try installing extensions directly
arjxn-py Jun 25, 2024
d57a1af
Merge branch 'main' into 10-host-readthedocs
rtimms Jun 25, 2024
2553b11
#10 fix conflicting optional dependencies
arjxn-py Jun 25, 2024
8db5127
#10 Update readme to point to the documentation
arjxn-py Jun 25, 2024
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
Prev Previous commit
Next Next commit
#10 fix conflicting optional dependencies
  • Loading branch information
@arjxn-py
arjxn-py committed Jun 25, 2024
commit 2553b11ec1878072dfed24ea2f6e635ebc8dea08
16 changes: 7 additions & 9 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,13 @@ dev = [
"pytest-html",
"pytest-cov",
]
docs = [
# Sphinx extensions
"autodoc",
"mathjax",
# Third-party extensions
"myst-parser",
]

[tools.setuptools]
packages = [
Expand All @@ -27,12 +34,3 @@ packages = [
[tool.setuptools.dynamic]
version = {attr = "pbeis.version.__version__"}
readme = {file = ["README.md"], content-type = "text/markdown"}

[project.optional-dependencies]
docs = [
# Sphinx extensions
"autodoc",
"mathjax",
# Third-party extensions
"myst_parser",
]