Skip to content

Commit 213a21f

Browse files
committed
docs: refactor sphinx-readme-io -> sphinx-rdme
1 parent f759dec commit 213a21f

File tree

5 files changed

+80
-75
lines changed

5 files changed

+80
-75
lines changed

.github/workflows/build.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ jobs:
6060
RDME_API_KEY: ${{ secrets.RDME_API_KEY }}
6161
run: |
6262
npm install -g rdme
63-
rdme docs upload docs/src/_build/readmeio/ --dry-run
63+
rdme docs upload docs/src/_build/rdme/ --dry-run
6464
6565
lint:
6666
name: Lint and Type Check

Makefile

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,14 @@ GIT_ROOT = $(shell git rev-parse --show-toplevel)
66
SPHINXDIR = $(GIT_ROOT)/docs/src
77
BUILDDIR = $(SPHINXDIR)/_build
88

9-
.PHONY: help clean html markdown readmeio docs
9+
.PHONY: help clean html markdown rdme docs
1010

1111
# Put it first so that "make" without argument is like "make help".
1212
help:
1313
@echo "Available targets:"
1414
@echo " html - Build HTML documentation"
1515
@echo " markdown - Build Markdown documentation"
16-
@echo " readmeio - Generate readme.io docs with frontmatter"
16+
@echo " rdme - Generate readme.io docs with frontmatter"
1717
@echo " docs - Build all (markdown, html, and readme.io)"
1818
@echo " clean - Remove build artifacts"
1919

@@ -33,10 +33,10 @@ markdown:
3333
@cp $(BUILDDIR)/markdown/*.md $(GIT_ROOT)/docs/
3434
@echo "Markdown files copied to docs/"
3535

36-
# Generate readme.io documentation with YAML frontmatter
37-
readmeio:
38-
@$(SPHINXBUILD) -M readmeio "$(SPHINXDIR)" "$(BUILDDIR)" $(SPHINXOPTS)
39-
@echo "readme.io docs generated in $(BUILDDIR)/readmeio/"
36+
# Generate rdme documentation with YAML frontmatter
37+
rdme:
38+
@$(SPHINXBUILD) -M rdme "$(SPHINXDIR)" "$(BUILDDIR)" $(SPHINXOPTS)
39+
@echo "Build finished. The rdme files are in $(BUILDDIR)/rdme."
4040

4141
# Build all documentation
42-
docs: clean markdown html readmeio
42+
docs: clean markdown html rdme

docs/src/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@
3939
"sphinx.ext.viewcode",
4040
"sphinx.ext.napoleon",
4141
"sphinx_markdown_builder",
42-
"sphinx_readme_io",
42+
"sphinx_rdme",
4343
]
4444

4545
# MyST Parser configuration

pyproject.toml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,14 +48,14 @@ docs = [
4848
"sphinx-rtd-theme>=2.0.0,<3",
4949
"pygments-ansi-color>=0.3.0,<1",
5050
"sphinx-markdown-builder>=0.6.0,<1",
51-
"sphinx-readme-io"
51+
"sphinx-rdme"
5252
]
5353

5454
[tool.uv]
5555
default-groups = "all"
5656

5757
[tool.uv.sources]
58-
sphinx-readme-io = { git = "https://github.com/jasondamour/sphinx-readme-io" }
58+
sphinx-rdme = { git = "https://github.com/jasondamour/sphinx-rdme" }
5959

6060
[build-system]
6161
requires = ["hatchling"]

0 commit comments

Comments
 (0)