summaryrefslogtreecommitdiff
path: root/doc/extdev/appapi.rst
Commit message (Collapse)AuthorAgeFilesLines
* Enable 'nit-picky mode' for Sphinx's documentationAdam Turner2023-04-061-8/+8
| | | | | Fix several reference errors throughout the documentation and set ``nitpick_ignore`` in ``doc/conf.py``.
* Mention nitpick_ignore(_regex) in docs of warn-missing-referenceHinrich Mahler2022-01-181-1/+3
|
* Merge pull request #9303 from tk0miya/fix_docslintTakeshi KOMIYA2021-06-061-5/+8
|\ | | | | doc: Fix docslint misunderstanding scope of code-blocks
| * doc: Fix docslint misunderstanding scope of code-blocksTakeshi KOMIYA2021-06-061-5/+8
| |
* | Close #9016: linkcheck builder failed to check the anchors of github.comTakeshi KOMIYA2021-06-011-0/+8
|/
* Docs: fix typo in env-merge-infoBrecht Machiels2021-03-301-1/+1
|
* Merge branch '3.x'Takeshi KOMIYA2021-01-241-37/+37
|\
| * doc: Show type annotations for methods of Sphinx application classTakeshi KOMIYA2021-01-241-37/+37
| |
* | Merge branch '3.x'Takeshi KOMIYA2021-01-081-0/+3
|\ \ | |/
| * Close #6241: html: Allow to add JS/CSS files to the specific pageTakeshi KOMIYA2021-01-071-0/+3
| | | | | | | | | | | | Allow to add JS/CSS files to the specific page when an extension calls `app.add_js_file()` or `app.add_css_file()` on `html-page-context` event.
* | Update the sphinx core events in appappi.rstFaris A Chugthai2020-12-211-8/+15
|/ | | | | | | | | | | | I'm very happy to see that the events in Sphinx have been laid out in order as they have been in this doc. With that being said the notation I noticed was a bit odd. Some of the items in the list refer to events and as a result, parenthesis are used to indicate the beginning and end of the parameters that the event takes. In other items in the list, parenthesis are used for additional context for an event. The combination of some particularly very long lines, the intermixing of comments, pseudo-code, indentation of items following a `for` or an `if` made this very difficult to read on a mobile device. As a result, I've added whitespace, fixed a typo, reduced the length of some lines by moving them to a new line, and removed all `()` that were not present to indicate parameters fed to a function.
* Fix #6914: Emit a detailed warning when failed to resolve :ref:Takeshi KOMIYA2020-11-031-0/+9
| | | | | | | | | To be clear the ambiguous warning for missing-reference :ref:, this separates the warning to missing-label and missing-caption. To emit a warning dynamically, this also adds a new event: `warn-missing-reference` to customize warning messages via event handlers.
* Correct numbersChris Sewell2020-08-211-6/+5
|
* 📚 DOCS: Improve build process overviewChris Sewell2020-08-201-1/+3
|
* output files commentChris Holdgraf2020-07-021-1/+1
|
* eventsChris Holdgraf2020-07-021-0/+34
|
* Allow NoUri from 'missing-reference' handlers.Jakob Lykke Andersen2020-05-171-2/+6
| | | | Also extend documentation of 'missing-reference'.
* doc: Update docsTakeshi KOMIYA2020-03-071-2/+1
|
* doc: Remove a mention to todo ext. from env-merge-infoTakeshi KOMIYA2020-03-061-5/+0
|
* Merge branch '2.0'Takeshi KOMIYA2020-01-301-1/+1
|\
| * Add new event: :event:`object-description-transform`Takeshi KOMIYA2020-01-251-0/+8
| |
* | Close #6830: autodoc: consider a member private if docstring has "private" ↵Takeshi KOMIYA2020-01-041-0/+8
| | | | | | | | metadata
* | Merge branch '2.0'Takeshi KOMIYA2019-05-291-3/+3
|\ \ | |/
| * doclinter: restrict by 90 columnsTakeshi KOMIYA2019-05-261-3/+3
| |
| * Make EventManager portableTakeshi KOMIYA2019-04-161-1/+1
| | | | | | | | | | | | So far, we need to bypass application object for modules to emit a event. This make EventManager portable and easy to pass event emitter. This brings modules less coupled with application object.
* | Make EventManager portableTakeshi KOMIYA2019-04-061-1/+1
| | | | | | | | | | | | So far, we need to bypass application object for modules to emit a event. This make EventManager portable and easy to pass event emitter. This brings modules less coupled with application object.
* | Drop features and APIs deprecated in 1.8Takeshi KOMIYA2019-03-301-2/+0
|/
* Add sphinx.project; a manipulator for project and documentsTakeshi KOMIYA2018-10-161-0/+4
|
* Drop APIs deprecated in 2.0Takeshi KOMIYA2018-09-031-26/+0
|
* Implement math_renderer frameworkTakeshi KOMIYA2018-07-281-0/+2
|
* docs: Fix location of attributesTakeshi KOMIYA2018-06-051-4/+4
|
* Merge pull request #5020 from tk0miya/5018_update_docsTakeshi KOMIYA2018-05-291-2/+2
|\ | | | | Fix #5018: wrong signature of env-merge-info and env-check-consistency
| * Fix #5018: wrong signature of env-merge-info and env-check-consistencyTakeshi KOMIYA2018-05-281-2/+2
| |
* | Merge branch 'master' into 3606_load_mathjax_asyncTakeshi KOMIYA2018-05-281-1/+1
|\ \
| * | Update docsTakeshi KOMIYA2018-05-241-1/+1
| |/
* | Rename app.add_javascript() to add_js_file()Takeshi KOMIYA2018-05-241-1/+1
| |
* | add_javascript() allows keyword arguments as attributes for <script> tagTakeshi KOMIYA2018-05-241-1/+1
|/
* Update docsTakeshi KOMIYA2018-02-251-0/+2
|
* Change interface of add_source_parser() and add add_source_suffix()Takeshi KOMIYA2018-02-211-1/+3
|
* doc: Add 'is_parallel_allowed'Stephen Finucane2018-01-211-0/+2
| | | | | | This is an important function and should be documented. Signed-off-by: Stephen Finucane <stephen@that.guru>
* doc: Reorder 'sphinx.application' docs to match codeStephen Finucane2018-01-211-15/+15
| | | | | | Use the same ordering to minimize cognitive load. Signed-off-by: Stephen Finucane <stephen@that.guru>
* doc: Move 'sphinx.application' API docs to codeStephen Finucane2018-01-211-436/+40
| | | | | | This allows us to do something like 'help(sphinx.application)' in code. Signed-off-by: Stephen Finucane <stephen@that.guru>
* doc: Rework 'sphinx.application' API documentationStephen Finucane2018-01-211-92/+161
| | | | Signed-off-by: Stephen Finucane <stephen@that.guru>
* Merge pull request #4465 from tk0miya/improve_configTakeshi KOMIYA2018-01-211-0/+6
|\ | | | | Improve config
| * Add config-inited eventTakeshi KOMIYA2018-01-201-0/+6
| |
* | doc: Move sphinx.config API docs to codeStephen Finucane2018-01-201-9/+2
| | | | | | | | | | | | | | Once again, we make things a little smarter by using Python domain roles. Signed-off-by: Stephen Finucane <stephen@that.guru>
* | doc: Move sphinx.errors API docs to codeStephen Finucane2018-01-201-31/+5
|/ | | | | | | This allows us to do something like 'help(sphinx.errors)' in code. We reword the exception descriptions per Python stdlib conventions. Signed-off-by: Stephen Finucane <stephen@that.guru>
* doc: Fix typoTakeshi KOMIYA2018-01-201-1/+1
|
* Update docs (refs: #3923)Takeshi KOMIYA2017-07-161-0/+22
|
* Mark as experimentalTakeshi KOMIYA2017-05-071-0/+2
|
View Lorry Controller Status