![[ChimeraX Issue Tracking System]](/trac/ChimeraX/chrome/site/ChimeraX-icon.svg){kind=icon}
Opened 3 years ago
Closed 3 years ago
#8523 closed defect (fixed)
Cruft in API reference
| Reported by: | Eric Pettersen | Owned by: | Zach Pearson |
|---|---|---|---|
| Priority: | moderate | Milestone: | 1.6 |
| Component: | Documentation | Version: | |
| Keywords: | Cc: | chimerax-programmers | |
| Blocked By: | Blocking: | ||
| Notify when closed: | Platform: | all | |
| Project: | ChimeraX |
Description
The listings in the Programmer's Guide / API Reference / Python Modules page are now all links, but there is a ton of extra cruft in most of the sections. For instance the Core / Data section should just have "models", "objects", and "session" but instead has 13 additional entries, e.g. "PickedModel" and "SESSION_SUFFIX".
Note:
See TracTickets
for help on using tickets.
I noticed that this comes from having nearly empty
rstfiles that only include the autodoc'd source code. See docs/devel/core/models.rst, which has cruft, vs docs/devel/core/tools.rst, which has no cruft. Apparently, just including a title is what makes the cruft go away. A fix will be on develop soon.