Skip to content

Publish API docs#21

Merged
bact merged 10 commits into
spdx:mainfrom
bact:publish-api-docs
Jun 17, 2026
Merged

Publish API docs#21
bact merged 10 commits into
spdx:mainfrom
bact:publish-api-docs

Conversation

@bact

@bact bact commented Mar 3, 2026

Copy link
Copy Markdown
Collaborator

Very basic API doc, using all pdoc defaults.

Version from "main" will be published to https://spdx.github.io/spdx-python-model/dev/.

Each tag-released version will be published to https://bact.github.io/spdx-python-model/<version_number>. (Only at the release time, no retrospec).

Note that pdoc does not support multiple versions natively. No drop-down menu for versions. If that is needed, may need to use Sphinx instead.

See demo at https://bact.github.io/spdx-python-model/dev/

bact added 5 commits March 3, 2026 13:29
Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
@bact bact added the documentation Improvements or additions to documentation label Mar 3, 2026
bact added 4 commits March 3, 2026 13:47
Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
@bact bact requested a review from JPEWdev March 3, 2026 06:57
@bact

bact commented Mar 5, 2026

Copy link
Copy Markdown
Collaborator Author

Comparing Sphinx (default theme & PyData theme which supports API versioning) and pdoc (default theme), pdoc navigation on the left pane is much easier to use.

  • Sphinx lists all the classes in the content area, which maybe fine if number of classes is small, but in our case it's a lot.
  • pdoc lists classes separately on the left pane, make it easier to navigate. The way it displays method signature also more compact.

Sphinx:

Screenshot 2569-03-05 at 12 03 02

pdoc:

Screenshot 2569-03-05 at 12 02 46

@bact bact merged commit 456105c into spdx:main Jun 17, 2026
6 checks passed
@bact bact deleted the publish-api-docs branch June 17, 2026 18:59
@bact

bact commented Jun 17, 2026

Copy link
Copy Markdown
Collaborator Author

@JPEWdev thank you. To have the API doc website deployed, we also need to enabled the GitHub Pages in the settings as well.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants