Skip to content

Commit e26f72d

Browse files
docs: replace pdoc with great-docs
1 parent 3be5c3b commit e26f72d

4 files changed

Lines changed: 6 additions & 7 deletions

File tree

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
[pre-commit]: https://pre-commit.com
1818
[pagefind]: https://pagefind.app
1919
[SemVer]: https://semver.org
20-
[pdoc]: https://pdoc.dev/
20+
[great-docs]: https://posit-dev.github.io/great-docs/
2121
[GitHub Actions]: https://github.com/features/actions
2222
[PyTorch]: https://pytorch.org
2323
[Scikit-Learn]: https://scikit-learn.org
@@ -88,7 +88,7 @@ ap tui
8888
- [project-website-template]
8989
- [pre-commit]
9090
- [GitHub Actions]
91-
- [pdoc]
91+
- [great-docs]
9292
- [commitizen]
9393
- [uv]
9494
- [ruff]

afterpython/doc/overview.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
[pre-commit]: https://pre-commit.com
55
[pagefind]: https://pagefind.app
66
[SemVer]: https://semver.org
7-
[pdoc]: https://pdoc.dev/
7+
[great-docs]: https://posit-dev.github.io/great-docs/
88
[GitHub Actions]: https://github.com/features/actions
99
[PyTorch]: https://pytorch.org
1010
[Scikit-Learn]: https://scikit-learn.org
@@ -47,7 +47,7 @@ ap tui
4747
- [project-website-template]
4848
- [pre-commit]
4949
- [GitHub Actions]
50-
- [pdoc]
50+
- [great-docs]
5151
- [commitizen]
5252
- [uv]
5353
- [ruff]

afterpython/doc/project_website.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[project-website-template]: https://github.com/AfterPythonOrg/project-website-template
22
[MyST]: https://mystmd.org
3-
[pdoc]: https://pdoc.dev/docs/pdoc.html
3+
[great-docs]: https://posit-dev.github.io/great-docs/
44
[PyPI]: https://pypi.org/
55
[WebLLM]: https://webllm.mlc.ai/
66
[PageFind]: https://pagefind.app/
@@ -150,7 +150,7 @@ featured_post = "getting-started.md"
150150
- AI chatbot using [WebLLM]
151151

152152
### API Reference
153-
[pdoc] will be used to build the API Reference section on the project website.
153+
[great-docs] will be used to build the API Reference section on the project website.
154154

155155
### FAQs
156156
`faq.yml` will be used as content for the FAQs section on the project website.

afterpython/doc/references/roadmap.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,6 @@ This roadmap is tentative and subject to change
66

77
- add `FAQ` section to the project website and handle `faq.yml`
88
- add announcement section to the landing page
9-
- integrate with `pdoc` for API reference generation
109
- convert blog posts to format compatible with medium.com and substack.com
1110
- AI chatbot like kapa.ai using WebLLM
1211
- full-text search engine using pagefind

0 commit comments

Comments
 (0)