summaryrefslogtreecommitdiff
path: root/sphinx/environment
Commit message (Collapse)AuthorAgeFilesLines
* Fix section numbering in domain object contents entries (#10830)Adam Turner2022-09-201-1/+4
|
* Fix nesting in domain object contents entries (#10828)Adam Turner2022-09-201-2/+1
|
* Add contents entries for domain objects (#10807)Adam Turner2022-09-131-27/+71
| | | | | | | | | - Add entries in the table of contents for domain objects (e.g. `py:function`, `rst:role`, etc). Supported domains are Javascript, Python, and reStructuredText. - Support content in `py:module` and `js:module` directives. - Add the `noindexentry` and `noindex` flags to more domains. - Add `toc_object_entries_show_parents` configuration setting - Update documentation and tests
* Make toctree accept special docnames (#10673)Brecht Machiels2022-09-122-1/+17
| | | | | | The `.. toctree::` directive now supports the reserved special docnames 'genindex', 'modindex', and 'search'. Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
* Privatise type (`DomainsType` -> `_DomainsType`)Adam Turner2022-09-121-5/+5
|
* More precise typing for `BuildEnvironment.domains` (#10813)Adam Turner2022-09-092-4/+59
|
* search: support searching for (sub)titles (#10717)Martin Liška2022-09-091-1/+1
| | | Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
* Further improve type annotations, reduce mypy whitelist (#10770)danieleades2022-08-283-14/+25
| | | Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
* Update include_patterns implementation (#10680)Adam Turner2022-07-231-1/+4
|
* Improve static typing strictness (#10569)danieleades2022-07-182-4/+4
|
* Add `include_patterns` as the opposite of `exclude_patterns` (#10518)Adam Turner2022-07-172-2/+2
|
* Use the `flake8-comprehensions` lint plugin (#10601)danieleades2022-06-261-2/+2
|
* Prefer `image_loading` over `embed_images`Adam Turner2022-04-221-1/+4
|
* Merge branch '4.x'Takeshi KOMIYA2022-03-1911-100/+12
|\
| * environment: Update default value for pep_base_urlMichal Čihař2022-03-161-1/+1
| | | | | | | | | | | | This matches docutils change in https://sourceforge.net/p/docutils/code/9045/ Fixes #10253
| * Collapse single line docstringsAdam Turner2022-02-2011-22/+11
| |
| * Remove copyright and licence fieldsAdam Turner2022-02-2011-33/+0
| |
| * Fix module docstring indentationAdam Turner2022-02-2011-22/+22
| |
| * Fix module docstring first lineAdam Turner2022-02-2011-22/+11
| |
| * Remove module titles in docstringsAdam Turner2022-02-1911-33/+0
| |
* | Merge branch '4.x'Takeshi KOMIYA2022-01-172-3/+3
|\ \ | |/
| * address some unused loop control variables (B007)Daniel Eades2022-01-122-3/+3
| |
* | Close #10062: Change the default language to 'en'Takeshi KOMIYA2022-01-122-10/+8
|/ | | | | Change the default language to `'en'` if any language is not set in `conf.py`.
* Migrate to Node.findall() from Node.traverse()Takeshi KOMIYA2022-01-035-11/+11
| | | | | | | | Node.traverse() was marked as deprecated since docutils-0.18. Instead of it, Node.findall() has been added as successor of traverse(). This applies a patch to docutils-0.17 or older to be available Node.findall() and use it.
* A happy new year!Takeshi KOMIYA2022-01-0111-11/+11
|
* Fix mypy violations (with mypy-0.930)Takeshi KOMIYA2021-12-241-1/+1
|
* Update RFC base urlMatt Ficke2021-11-161-1/+1
| | | | | | | | | The tools.ietf.org subdomain is being wound down and services are moving to datatracker.ietf.org. Links to RFC documents using the old subdomain are being redirected to datatracker; this updates the configured `rfc_base_url` to point to the current subdomain. Discussion: https://mailarchive.ietf.org/arch/msg/ietf/0n-6EXEmkTp3Uv_vj-5Vnm3o0bo/
* Support docutils-0.18: Consume iterator of Element.traverse()Takeshi KOMIYA2021-10-271-2/+2
| | | | | | | Since 0.18, Element.traverse() returns an iterator instead of intermediate object. As a result, the return value is always considered as truthy value. And it becomes fragile when the caller modifies the doctree on the loop.
* Merge pull request #9724 from tk0miya/support_PreBibliographic_nodesTakeshi KOMIYA2021-10-231-3/+6
|\ | | | | Support docutils-0.18: allow PreBibliographic nodes before docinfo
| * Support docutils-0.18: allow PreBibliographic nodes before docinfoTakeshi KOMIYA2021-10-231-3/+6
| | | | | | | | | | | | | | | | Since 0.18, `meta` directive inserts meta node into the top of the document. It confuses MetadataCollector. This allows doctree contains PreBibliographic nodes just before docinfo node.
* | Support docutils-0.18: Set auto_id_prefix explicitlyTakeshi KOMIYA2021-10-111-0/+1
|/ | | | | | Since docutils-0.18, auto_id_prefix setting will be changed to `'%'` from `'id'`. To keep backward compatibility of node IDs, this sets `'id'` to settings explicitly.
* Support docutils-0.18; Disable embed_images and section_self_linkTakeshi KOMIYA2021-10-031-0/+2
| | | | | | | | | embed_images: HTML Builder always use non-embeded (linked) images. section_self_link: HTML Builder controls hyperlink generation for each section via `html_permalinks` option.
* Fix typos discovered by codespellChristian Clauss2021-09-081-1/+1
|
* Fix typoEisuke Kawashima2021-07-081-1/+1
|
* 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: Upgrade docutils.sourceforge.io links to HTTPSigo958622021-05-161-1/+1
|/ | | | | Also change any docutils.sourceforge.net link to io top level domain.
* refactor: Add Optional to type annotationsTakeshi KOMIYA2021-05-103-9/+9
|
* refactor: Add Optional to type annotationsTakeshi KOMIYA2021-05-031-2/+2
|
* Merge pull request #9053 from tk0miya/title_node_for_toctree_captionTakeshi KOMIYA2021-04-091-1/+1
|\ | | | | Fix #8870: Use title node for the caption of toctree
| * Fix #8870: Use title node for the caption of toctreeTakeshi KOMIYA2021-04-091-1/+1
| | | | | | | | | | Since docutils-0.17, the caption node should not use for the non-figure nodes. Therefore, this replaces it by the title node.
* | refactor: use raw Type for type annotationsTakeshi KOMIYA2021-04-041-1/+1
| |
* | refactor: Use PEP-526 based variable annotation (sphinx.environment)Takeshi KOMIYA2021-03-256-82/+79
| |
* | Merge branch '3.x'Takeshi KOMIYA2021-03-201-2/+3
|\ \ | |/
| * Fix #8959: using UNIX path separator confuses Sphinx on WindowsTakeshi KOMIYA2021-03-201-2/+3
| | | | | | | | | | The first element of env.relfn2path() should be a POSIX path, not a OS dependent path.
* | Merge pull request #8937 from jantonguirao/fix_explicit_title_subpagesTakeshi KOMIYA2021-03-021-1/+1
|\ \ | | | | | | Use explicit title instead of <no title> in the title bar of subpages
| * | Apply code review suggestionsJoaquin Anton2021-03-011-4/+3
| | | | | | | | | | | | Signed-off-by: Joaquin Anton <janton@nvidia.com>
| * | Use explicit title for titlenode, when no title is providedJoaquin Anton2021-02-261-3/+4
| |/ | | | | | | Signed-off-by: Joaquin Anton <janton@nvidia.com>
* | Close #8326: Rename master_doc to root_docTakeshi KOMIYA2021-02-283-4/+4
| | | | | | | | | | | | To describe the purpose more accurately, the `master_doc` is now renamed to `root_doc`. The old name is still available. But it is recommeneded to use new one from now on.
* | Merge branch '3.x'Takeshi KOMIYA2021-01-221-3/+4
|\ \ | |/