Publish the package and its documentation, and move to the papers organization
Add the Zensical documentation of the Python package (docs/package, built by the docs workflow), merge the standard publish workflow with the setuptools-scm tag check, add the SPDX header rule to ruff, restructure the README, and point every repository and registry address at the Gitea organization papers. Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01B8cL4zN4XpaQF5cBtASzfq
This commit is contained in:
37 files changed
+1005
-83
No files matched your search
+100
@@ -0,0 +1,100 @@
|
||||
# The documentation site (Zensical): https://docs.scient.ing/paperspec/
|
||||
# `pixi run -e docs docs-build` builds it strictly into build/docs; `docs-serve` previews it.
|
||||
|
||||
[project]
|
||||
site_name = "paperspec"
|
||||
site_description = "The Python package and the commands of paperspec, the reference implementation of the scienting formats"
|
||||
site_url = "https://docs.scient.ing/paperspec/"
|
||||
repo_url = "https://git.scient.ing/papers/paperspec"
|
||||
repo_name = "papers/paperspec"
|
||||
copyright = "Scientific Computing Studio, LLC"
|
||||
# paperspec-specific: docs/ already holds the guides to the formats, which `paperspec site` renders on
|
||||
# https://paperspec.scient.ing, so these pages for the Python package live in a subfolder of it.
|
||||
docs_dir = "docs/package"
|
||||
site_dir = "build/docs"
|
||||
use_directory_urls = true
|
||||
|
||||
# Every page appears here, so a page nobody links to fails the strict build.
|
||||
nav = [
|
||||
{ "Home" = "index.md" },
|
||||
{ "Get started" = [
|
||||
"start/index.md",
|
||||
"start/install.md",
|
||||
"start/quick-start.md",
|
||||
] },
|
||||
{ "Guides" = [
|
||||
"guides/index.md",
|
||||
"guides/validate-a-package.md",
|
||||
"guides/load-into-sqlite.md",
|
||||
"guides/use-the-library.md",
|
||||
"guides/check-and-build.md",
|
||||
] },
|
||||
{ "Reference" = [
|
||||
"reference/index.md",
|
||||
"reference/cli.md",
|
||||
"reference/api.md",
|
||||
] },
|
||||
{ "About" = [
|
||||
"about/index.md",
|
||||
"about/changelog.md",
|
||||
"about/llm-assistance.md",
|
||||
"about/license.md",
|
||||
] },
|
||||
]
|
||||
|
||||
[project.theme]
|
||||
language = "en"
|
||||
font = false # system fonts: no request to a font host
|
||||
features = [
|
||||
"content.code.annotate",
|
||||
"content.code.copy",
|
||||
"content.tabs.link",
|
||||
"content.tooltips",
|
||||
"navigation.footer",
|
||||
"navigation.indexes",
|
||||
"navigation.instant",
|
||||
"navigation.instant.prefetch",
|
||||
"navigation.path",
|
||||
"navigation.sections",
|
||||
"navigation.tabs",
|
||||
"navigation.top",
|
||||
"navigation.tracking",
|
||||
"search.highlight",
|
||||
"toc.follow",
|
||||
]
|
||||
|
||||
[[project.theme.palette]]
|
||||
media = "(prefers-color-scheme)"
|
||||
toggle.icon = "lucide/sun-moon"
|
||||
toggle.name = "Switch to light mode"
|
||||
|
||||
[[project.theme.palette]]
|
||||
media = "(prefers-color-scheme: light)"
|
||||
scheme = "default"
|
||||
toggle.icon = "lucide/sun"
|
||||
toggle.name = "Switch to dark mode"
|
||||
|
||||
[[project.theme.palette]]
|
||||
media = "(prefers-color-scheme: dark)"
|
||||
scheme = "slate"
|
||||
toggle.icon = "lucide/moon"
|
||||
toggle.name = "Switch to system preference"
|
||||
|
||||
[project.markdown_extensions]
|
||||
abbr = {}
|
||||
admonition = {}
|
||||
attr_list = {}
|
||||
def_list = {}
|
||||
footnotes = {}
|
||||
md_in_html = {}
|
||||
toc.permalink = true
|
||||
pymdownx.betterem = {}
|
||||
pymdownx.details = {}
|
||||
pymdownx.highlight.anchor_linenums = true
|
||||
pymdownx.highlight.line_spans = "__span"
|
||||
pymdownx.highlight.pygments_lang_class = true
|
||||
pymdownx.inlinehilite = {}
|
||||
pymdownx.keys = {}
|
||||
pymdownx.superfences = {}
|
||||
pymdownx.tabbed.alternate_style = true
|
||||
pymdownx.tasklist.custom_checkbox = true
|
||||
Reference in new issue
Block a user