summaryrefslogtreecommitdiff
path: root/doc/extdev
Commit message (Collapse)AuthorAgeFilesLines
* Mention nitpick_ignore(_regex) in docs of warn-missing-referenceHinrich Mahler2022-01-181-1/+3
|
* Fix #9752: autodoc: Failed to detect type annotation for slots attributeTakeshi KOMIYA2021-10-231-0/+5
|
* Fix #9710: html: Wrong styles for even/odd rows in nested tablesTakeshi KOMIYA2021-10-091-0/+20
|
* Merge branch '4.x' into 9683_add_css_fileTakeshi KOMIYA2021-10-091-0/+5
|\
| * js nodes, docs, add entry in deprecation/removal tableJakob Lykke Andersen2021-10-031-0/+5
| |
* | Close #9683: Revert the removal of ``add_stylesheet()`` APITakeshi KOMIYA2021-10-031-1/+1
|/ | | | | | | It will be kept until the Sphinx-6.0 release. Note: Now it emits a warning instead of DeprecationWarning to let the users know the deprecation.
* Merge pull request #9666 from tk0miya/9662_docs_for_ObjectDescriptionTakeshi KOMIYA2021-09-271-0/+4
|\ | | | | Add doc for ObjectDescription (refs: #9662)
| * Add doc for ObjectDescription (refs: #9662)Takeshi KOMIYA2021-09-231-0/+4
| |
* | Fix #9637: Add Builder.allow_parallel to the list of builder APIsTakeshi KOMIYA2021-09-181-0/+1
|/
* Fix typoEisuke Kawashima2021-07-081-2/+2
|
* Merge branch '4.0.x' into 4.xTakeshi KOMIYA2021-06-301-1/+1
|\
| * Revert the removal of sphinx.util:force_decode()Takeshi KOMIYA2021-06-131-1/+1
| | | | | | | | | | | | | | | | | | | | After the release of 4.0.0, some 3rd party extensions have became not working with the latest Sphinx because `force_decode()` function was removed. It was deprecated since Sphinx-2.0 and warned for the removal since 3.0. This reverts the removal and extends its deprecation period to 5.0.0. I hope it helps users of these extensions.
* | Fix #9032: docs: sphinx.environment.NoUri was removed at v3.0.0Takeshi KOMIYA2021-06-141-1/+2
| | | | | | | | | | Our deprecation list describes `sphinx.environment.NoUri` was removed at v4.0.0. But, acutally, it was removed at v3.0.0 (#6223).
* | 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
| | |
* | | Merge pull request #9260 from tk0miya/9016_linkcheck_github_anchorsTakeshi KOMIYA2021-06-041-0/+8
|\ \ \ | |/ / |/| | Close #9016: linkcheck builder failed to check the anchors of github.com
| * | Close #9016: linkcheck builder failed to check the anchors of github.comTakeshi KOMIYA2021-06-011-0/+8
| | |
* | | deprecate sphinx.ext.autosummary._appTakeshi KOMIYA2021-05-311-0/+5
|/ /
* | Merge pull request #9242 from tk0miya/refactor_env2Takeshi KOMIYA2021-05-221-0/+5
|\ \ | | | | | | refactor: Make the app argument for BuildEnvironment required
| * | refactor: Make the app argument for BuildEnvironment requiredTakeshi KOMIYA2021-05-221-0/+5
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | At present, some attributes of env object are considered as optional because they have been initialized by None on the constructor. But they have always been fullfilled actually. To be clear the type hints of the env object, this makes the `app` argument for the BuildEnvironment class required. It can ensure the attributes of env object are not optional.
* | | doc: Upgraded babel.pocoo.org links to HTTPSigo958622021-05-161-1/+1
| | |
* | | doc: Upgrade docutils.sourceforge.io links to HTTPSigo958622021-05-163-3/+3
|/ / | | | | | | | | Also change any docutils.sourceforge.net link to io top level domain.
* | Deprecate app.html_themesTakeshi KOMIYA2021-05-121-0/+5
| | | | | | | | | | The register is much better to store the HTML themes instead of the application object. So this migrates it to the registry object.
* | Fix typos in doc/extdev/deprecated.rstDmitry Shachnev2021-05-091-3/+3
| |
* | Fix #8597: autodoc: metadata only docstring is treated as undocumentedTakeshi KOMIYA2021-05-021-0/+5
|/ | | | | The metadata in docstring is invisible content. Therefore docstring having only metadata should be treated as undocumented.
* Merge pull request #9050 from tk0miya/8829_whats_parallel_read_safeTakeshi KOMIYA2021-04-181-0/+16
|\ | | | | Close #8829: doc: Update description of paralle-read-safe
| * Close #8829: doc: Update description of paralle-read-safeTakeshi KOMIYA2021-04-041-0/+16
| |
* | Decl styling, make desc_inline nodeJakob Lykke Andersen2021-04-121-0/+1
| | | | | | | | Use the new node for cpp:expr
* | Decl styling, docs and restructuringJakob Lykke Andersen2021-04-121-2/+15
|/
* Docs: fix typo in env-merge-infoBrecht Machiels2021-03-301-1/+1
|
* Deprecate DocumenterBridge.warn()Takeshi KOMIYA2021-03-221-0/+5
| | | | | | | | Since 1.6, sphinx.util.logging module became the default logging interface of Sphinx. It allows sphinx-components to output log without the app (or env) object. According to the policy, DocumenterBridge.warn() is no longer needed and should be replaced by the logging module.
* Rename DocumenterBridge.filename_set to record_dependenciesTakeshi KOMIYA2021-03-211-0/+5
| | | | | | | DocumenterBridge.filename_set has been used since its beginning. On the other hand, in docutils, record_dependencies attribute is well-used to store the list of dependency files. So this renames it to docutils' standard attribute.
* refactor: Add a type alias for the option_spec of directives; OptionSpecTakeshi KOMIYA2021-03-131-0/+5
|
* Close #8487: csv-table now considers abspath as relpath from srcdirTakeshi KOMIYA2021-03-091-5/+0
| | | | | | To make directives' behavior consistent, the :file: option for csv-table directive now recognizes an absolute path as a relative path from source directory.
* Merge pull request #8432 from tk0miya/7119_pending_xref_conditionTakeshi KOMIYA2021-03-061-0/+1
|\ | | | | Fix #7119: Show type hint names unqualified when resolving succeeded
| * Add pending_xref_condition nodeTakeshi KOMIYA2021-03-061-0/+1
| | | | | | | | | | | | To choose appropriate content for pending_xref node on resolving, this introduces a new custom node `pending_xref_condition`. It only has a condition for the filtering and contents of the reference.
* | Deprecate SphinxComponentRegistry.get_source_input()Takeshi KOMIYA2021-03-021-0/+10
|/ | | | | | The source_input system was deprecated at v2.0. So no client uses it longer now. Therefore this deprecate the getter interface and its usage.
* Merge branch '3.x'Takeshi KOMIYA2021-02-131-0/+15
|\
| * refactor: linkcheck: Separate thread manager feature from builder classTakeshi KOMIYA2021-02-121-0/+15
| | | | | | | | | | | | To reduce the complexity of the linkcheck builder, this separates the thread manager feature from the builder class as HyperlinkAvailabilityChecker.
* | Merge branch '3.x'Takeshi KOMIYA2021-02-071-0/+15
|\ \ | |/
| * refactor: linkcheck: Deprecate attributes of linkcheck buildersTakeshi KOMIYA2021-02-071-0/+15
| | | | | | | | | | Move anchors_ignore, auth and to_ignore to HyperlinkAvailabilityCheckWorker and become deprecated.
* | Merge branch '3.x'Takeshi KOMIYA2021-01-301-5/+1
|\ \ | |/
| * Fix #8780: long words in narrow columns may not be hyphenatedjfbu2021-01-291-5/+1
| | | | | | | | This is done by adding '\hskip0pt\relax\n' whenever a paragraph starts.
* | Merge pull request #8737 from tk0miya/8510_html_logo_urlTakeshi KOMIYA2021-01-241-0/+10
|\ \ | | | | | | Allow user to use url to reference html logo & favicon
| * | Update CHANGESTakeshi KOMIYA2021-01-231-2/+2
| | |
| * | Merge branch 'master' into 8510_html_logo_urlTakeshi KOMIYA2021-01-234-10/+138
| |\ \
| * | | html theme: Add `favicon_url` and `logo_url`Takeshi KOMIYA2021-01-231-0/+10
| | | | | | | | | | | | | | | | | | | | | | | | | | | | To embed the external favicon and logo image, this adds new template variable `favicon_url` and `logo_url` that point the external URL or relative path for the favicon/logo file from current file. It helps to use it on template files.
* | | | Merge branch '3.x'Takeshi KOMIYA2021-01-242-37/+47
|\ \ \ \ | |_|/ / |/| | / | | |/ | |/|
| * | Close #6550: html: Allow to use HTML permalink textsTakeshi KOMIYA2021-01-241-0/+10
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Add new configuration variables: `html_permalinks` and `html_permalinks_icon`. This refines the settings around HTML permalinks. * html_add_permalinks * Deprecated. * html_permalinks * Enable or disable permalinks feature. * html_permalinks_icon * Change the icon for permalinks
| * | doc: Show type annotations for methods of Sphinx application classTakeshi KOMIYA2021-01-241-37/+37
| | |