Skip to content

Commit a345824

Browse files
committed
feat: resolve #4
1 parent eae40b2 commit a345824

File tree

3 files changed

+14
-1
lines changed

3 files changed

+14
-1
lines changed

Diff for: .github/workflows/docs.yaml

+2-1
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ jobs:
1515
cache: 'pip'
1616
- name: Install dependencies
1717
run: |
18-
pip install hatch pdocs mkdocs-material mkdocs-jupyter mkdocs-plantuml-local
18+
pip install hatch pdocs mkdocs-material mkdocs-jupyter mkdocs-plantuml-local pydoctor
1919
hatch build
20+
pydoctor
2021
mkdocs gh-deploy --force

Diff for: mkdocs.yml

+1
Original file line numberDiff line numberDiff line change
@@ -42,4 +42,5 @@ nav:
4242
- 1.2.0: 'conformance/1.2.0.md'
4343
- 1.2.1: 'conformance/1.2.1.md'
4444
- Development:
45+
- API Docs: 'apidocs/index.html'
4546
- Class diagram: 'puml/class.md'

Diff for: pydoctor.ini

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
[pydoctor]
2+
project-name=Calrissian
3+
project-version=0.18.2
4+
project-url=https://duke-gcb.github.io/calrissian/
5+
project-base-dir=./calrissian
6+
html-output=./docs/apidocs
7+
add-package =
8+
calrissian
9+
docformat = restructuredtext
10+
verbose = 1
11+
warnings-as-errors = true

0 commit comments

Comments
 (0)