HomeClusterLabs Projects

Refactor: doc: Don't use autosummary in the python documentation.
b1cf48c14a5bUnpublished

Unpublished Commit ยท Learn More

Not On Permanent Ref: This commit is not an ancestor of any permanent ref.
This commit no longer exists in the repository. It may have been part of a branch which was deleted.This commit has been deleted in the repository: it is no longer reachable from any branch, tag, or ref.

Description

Refactor: doc: Don't use autosummary in the python documentation.

Before, I was using autosummary to generate the docs for us, but as the
previous commit explained, this caused various problems. In addition,
it's really just not necessary - we only have a couple python modules,
we're adding them at an extremely slow rate, and we're probably never
going to have more than a handful anyway. Adding docs by hand is just
not that much of a burden.

In addition, conditionalize the index to not show up when we are
generating the singlehtml format. It doesn't work there, so we
shouldn't add it.

Details

Provenance
clumensAuthored on Jan 24 2025, 1:08 PM

Event Timeline

Commit No Longer Exists

This commit no longer exists in the repository.