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.

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

Actually publish sphinx-based documentation. #325

Merged
merged 4 commits into from
Nov 1, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
9 changes: 0 additions & 9 deletions .cirrus.yml
Original file line number Diff line number Diff line change
@@ -1,12 +1,3 @@
# Allow compute credits usage for collaborators and anything pushed to the
# main, staging, and trying branches. (So bors can use them.)
use_compute_credits: $CIRRUS_USER_COLLABORATOR == 'true' || $CIRRUS_BRANCH == 'main' || $CIRRUS_BRANCH == 'staging' || $CIRRUS_BRANCH == 'trying'

# This makes Click behave itself.
env:
LC_ALL: C.UTF-8
LANG: C.UTF-8

Lint_task:
container:
image: python:3.11-slim
Expand Down
4 changes: 2 additions & 2 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ python:
install:
- requirements: docs-requirements.txt

mkdocs:
configuration: mkdocs.yml
sphinx:
configuration: docs/source/conf.py

# Build PDF & ePub versions of docs.
formats:
Expand Down
14 changes: 0 additions & 14 deletions mkdocs.yml

This file was deleted.

7 changes: 3 additions & 4 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@ authors = [
description = "A program to help build, maintain, and release PEP 517-compliant projects."
readme = "README.md"
license = {text = "MIT"}
#packages = ["bork"]
classifiers = [
"Programming Language :: Python :: 3",
"Programming Language :: Python :: 3.8",
Expand Down Expand Up @@ -55,14 +54,14 @@ docs = [
"sphinx",
"sphinx-rtd-theme",
"sphinx-argparse",
#"mkdocs==1.4.2",
#"mkdocstrings[python]==0.21.2",
#"jinja2==3.0.0",
]

[project.scripts]
bork = "bork.cli:main"

[tool.setuptools]
packages = ["bork"]

[tool.setuptools.dynamic]
version = {attr = "bork.__version__"}

Expand Down