Closed
Bug 1805810
Opened 3 years ago
Closed 1 year ago
make docs configuration more useful
Categories
(MailNews Core :: Build Config, enhancement)
MailNews Core
Build Config
Tracking
(thunderbird_esr102 wontfix, thunderbird109 wontfix)
RESOLVED
FIXED
110 Branch
People
(Reporter: rjl, Assigned: rjl)
References
Details
(Keywords: leave-open)
Attachments
(1 file)
The initial configuration for the source docs works fine for ReadTheDocs purposes, but building locally fails and the setup itself is not very useful as it's a bare-bones config.
Some extensions to add:
- myst_parser (add markdown support)
- sphinx.ext.autodoc (Python docstring support)
- sphinx.ext.autosectionlabel (refer to sections by title - needed for mots.yaml)
- sphinx.ext.doctest (test code snippets in docs)
- sphinx.ext.graphviz (embed Graphviz graphs)
- sphinx.ext.napoleon (better docstrings)
- sphinx.ext.todo (todo items)
- bzlink (auto linking to bugs in bugzilla)
bzlink is a small extension that can be copied from m-c. The sphinx.ext. extensions are included with Sphinx, and myst_parser is supported nicely by RTD.
Additionally, there is some custom CSS and templates in m-c docs that are helpful.
|
Assignee | |
Comment 1•3 years ago
|
||
|
||
Updated•3 years ago
|
Assignee: nobody → rob
Status: NEW → ASSIGNED
|
|
Assignee | |
Updated•3 years ago
|
status-thunderbird109:
--- → wontfix
status-thunderbird_esr102:
--- → wontfix
Keywords: checkin-needed-tb,
leave-open
Target Milestone: --- → 110 Branch
Pushed by alessandro@thunderbird.net:
https://hg.mozilla.org/comm-central/rev/ad9d09f56d2f
Incremental improvements to source-docs building. r=dandarnell
Keywords: checkin-needed-tb
|
|
Assignee | |
Updated•1 year ago
|
Status: ASSIGNED → RESOLVED
Closed: 1 year ago
Resolution: --- → FIXED
You need to log in
before you can comment on or make changes to this bug.
Description
•