Commit graph

6 commits

Author SHA1 Message Date
Sebastian Mohr
9584216209
Streamlined auto api referencing for documentation (#5795)
## Description

The current developer documentation feels somewhat cluttered due to
inline auto-generated API references for certain classes. To improve
readability and maintainability, this PR introduces a more streamlined
approach that aligns better with best practices observed in other PyData
ecosystem documentation.

Specifically, this PR:
- Adds a dedicated `api/` folder to the documentation structure.
- Moves all auto-generated references (classes, methods, etc.) to this
folder.
- Enables clean, concise linking to API elements from the narrative
documentation—without interrupting human-written content with large
autogenerated blocks.

This separation makes the documentation easier to navigate and maintain,
while still providing full API reference coverage where needed.

- [x] Documentation
- [x] Changelog
2025-05-22 11:35:40 +02:00
Adrian Sampson
4634c7a9b8 Add new livereload server for docs 2016-01-25 13:19:26 -08:00
Adrian Sampson
f7fe10a376 make auto: Ignore "deleted" events
vim's atomic writes delete the file and then re-add it, which was leading to
Sphinx being triggered twice.
2014-10-30 15:54:39 -07:00
Adrian Sampson
613c85ad6e Plugin docs overhaul tweaks through "duplicates"
Moving alphabetically through the docs. Got a long way to go...
2014-10-30 11:42:27 -07:00
Adrian Sampson
1613f9b773 Release script: build command 2014-05-02 14:09:59 -07:00
Adrian Sampson
18aff4db01 Sphinx documentation skeleton 2011-09-16 13:57:15 -07:00