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

remove doc dependency group from prod dependencies #358

Closed
wants to merge 1 commit into from
Closed

remove doc dependency group from prod dependencies #358

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 1 addition & 0 deletions changelog.d/+move_doc_extras_to_dev.removed.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Removed `[doc]` extras dependency group (moved it to dev dependencies).
4 changes: 2 additions & 2 deletions noxfile.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -185,7 +185,7 @@ def build(session):
@nox.session(python=PYTHON_DEFAULT_VERSION)
def doc(session):
"""Build the documentation."""
pdm_install(session, 'doc', dev=False)
pdm_install(session, 'doc')
session.cd('doc')
sphinx_args = ['-b', 'html', '-T', '-W', 'source', 'build/html']
session.run('rm', '-rf', 'build', external=True)
Expand All @@ -203,7 +203,7 @@ def doc(session):
@nox.session
def doc_cover(session):
"""Perform coverage analysis for the documentation."""
pdm_install(session, 'doc', dev=False)
pdm_install(session, 'doc')
session.cd('doc')
sphinx_args = ['-b', 'coverage', '-T', '-W', 'source', 'build/coverage']
report_file = 'build/coverage/python.txt'
Expand Down
4 changes: 2 additions & 2 deletions pdm.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

22 changes: 9 additions & 13 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,19 +31,6 @@ classifiers = [
"Programming Language :: Python :: 3.12",
]

[project.optional-dependencies]
# doc group should be moved to dev dependencies when we release
# a new major version.
doc = [
"sadisplay>=0.4.9",
"sphinx>=5.3.0, <6",
"sphinx-autobuild>=2021.3.14",
"sphinx-rtd-theme>=2.0.0",
"sphinx-autodoc-typehints>=1.23.0",
"sphinxcontrib-plantuml>=0.27",
"tornado>=6.3.3; python_version>='3.8'",
]

[project.urls]
Homepage = "https://github.com/Backblaze/b2-sdk-python"

Expand Down Expand Up @@ -184,3 +171,12 @@ test = [
release = [
"towncrier==23.11.0; python_version>='3.8'",
]
doc = [
"sadisplay>=0.4.9",
"sphinx>=5.3.0, <6",
"sphinx-autobuild>=2021.3.14",
"sphinx-rtd-theme>=2.0.0",
"sphinx-autodoc-typehints>=1.23.0",
"sphinxcontrib-plantuml>=0.27",
"tornado>=6.3.3; python_version>='3.8'",
]
Loading