summaryrefslogtreecommitdiff
path: root/sphinx/application.py
Commit message (Collapse)AuthorAgeFilesLines
...
| * Merge pull request #9242 from tk0miya/refactor_env2Takeshi KOMIYA2021-05-221-2/+1
| |\ | | | | | | refactor: Make the app argument for BuildEnvironment required
| | * refactor: Make the app argument for BuildEnvironment requiredTakeshi KOMIYA2021-05-221-2/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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.
| * | Merge pull request #9239 from igo95862/https-linksTakeshi KOMIYA2021-05-191-3/+3
| |\ \ | | |/ | |/| Upgrade URLs to use HTTPS
| | * doc: Upgrade docutils.sourceforge.io links to HTTPSigo958622021-05-161-3/+3
| | | | | | | | | | | | | | | Also change any docutils.sourceforge.net link to io top level domain.
| * | refactor: Do config file existence check in Config.read()Takeshi KOMIYA2021-05-161-12/+5
| |/
| * Deprecate app.html_themesTakeshi KOMIYA2021-05-121-4/+11
| | | | | | | | | | The register is much better to store the HTML themes instead of the application object. So this migrates it to the registry object.
| * refactor: Add Optional to type annotationsTakeshi KOMIYA2021-05-101-4/+4
| |
* | Rename variable to `html_assets_policy`Manuel Kaufmann2021-06-141-8/+12
| |
* | Add `Sphinx.add_html_assets_in_all_pages`Manuel Kaufmann2021-05-061-0/+8
|/ | | | | | | | | | | | | This new method in the `Sphinx` object allows extensions to communicate to Sphinx that it's preferred to include HTML assets in all the pages. However, it's extensions developers' responsability to follow this config and decide whether or not include the assets required. Extensions developers' can check `Sphinx.html_assets_in_all_pages` together with any other logic they may have to decide if the assets will be included in the rendered page or not. Closes #9115
* Merge branch 'master' into patch-1Takeshi KOMIYA2021-04-101-70/+38
|\
| * Merge pull request #9064 from tk0miya/refactor_type_annotationTakeshi KOMIYA2021-04-081-2/+1
| |\ | | | | | | refactor: Add Optional to type annotations
| | * refactor: Add Optional to type annotationsTakeshi KOMIYA2021-04-081-2/+1
| | |
| * | refactor: Use PEP-526 based variable annotationTakeshi KOMIYA2021-04-081-9/+9
| |/
| * refactor: use raw Type for type annotationsTakeshi KOMIYA2021-04-041-17/+17
| |
| * doc: Link autodoc tutorial in add_autodocumenter docstringigo958622021-03-091-1/+1
| | | | | | | | Uses :ref: link because :doc: does not work.
| * Update type annotationsTakeshi KOMIYA2021-02-091-0/+3
| |
| * Merge branch '3.x'Takeshi KOMIYA2021-01-281-55/+69
| |\
| * \ Merge branch '3.x'Takeshi KOMIYA2021-01-241-27/+40
| |\ \
| * \ \ Merge branch '3.x'Takeshi KOMIYA2021-01-241-0/+4
| |\ \ \
| * \ \ \ Merge branch '3.x'Takeshi KOMIYA2021-01-081-7/+17
| |\ \ \ \
| * | | | | refactor: Move CSS tags in basic/layout.html to ``css_files`` variableTakeshi KOMIYA2021-01-031-0/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | To make CSS customizable, all CSS files in basic/layout.html has their priority: 200. Therefore, extensions and users can insert their own custom CSS files before or just after them. As a side effect, the CSS tags in basic/layout.html are removed. These CSS files will be rendered via `css_files` template variable. refs: #8634, c5f03980107e123210fb602f4c31f5ae950e2af4
| * | | | | Merge branch '3.x'Takeshi KOMIYA2021-01-031-13/+41
| |\ \ \ \ \
| * \ \ \ \ \ Merge branch '3.x'Takeshi KOMIYA2021-01-011-1/+1
| |\ \ \ \ \ \
| * \ \ \ \ \ \ Merge branch '3.x'Takeshi KOMIYA2020-11-211-3/+3
| |\ \ \ \ \ \ \
| * \ \ \ \ \ \ \ Merge branch '3.x'Takeshi KOMIYA2020-11-121-7/+6
| |\ \ \ \ \ \ \ \
| * \ \ \ \ \ \ \ \ Merge branch '3.x'Takeshi KOMIYA2020-10-241-8/+57
| |\ \ \ \ \ \ \ \ \
| * \ \ \ \ \ \ \ \ \ Merge branch '3.x' into masterTakeshi KOMIYA2020-10-041-2/+5
| |\ \ \ \ \ \ \ \ \ \
| * \ \ \ \ \ \ \ \ \ \ Merge tag 'v3.1.0'Takeshi KOMIYA2020-07-051-1/+1
| |\ \ \ \ \ \ \ \ \ \ \
| * \ \ \ \ \ \ \ \ \ \ \ Merge branch '3.x'Takeshi KOMIYA2020-06-041-7/+22
| |\ \ \ \ \ \ \ \ \ \ \ \
| * \ \ \ \ \ \ \ \ \ \ \ \ Merge branch '3.x'Takeshi KOMIYA2020-05-171-1/+1
| |\ \ \ \ \ \ \ \ \ \ \ \ \
| * | | | | | | | | | | | | | Remove deprecated features marked as RemovedInSphinx40WarningTakeshi KOMIYA2020-04-291-36/+3
| | | | | | | | | | | | | | |
| * | | | | | | | | | | | | | Merge branch '3.x'Takeshi KOMIYA2020-03-211-6/+12
| |\ \ \ \ \ \ \ \ \ \ \ \ \ \
| * \ \ \ \ \ \ \ \ \ \ \ \ \ \ Merge branch '3.x'Takeshi KOMIYA2020-03-121-1/+1
| |\ \ \ \ \ \ \ \ \ \ \ \ \ \ \
| * | | | | | | | | | | | | | | | Hello TYPE_CHECKING!Takeshi KOMIYA2020-03-071-3/+2
| | | | | | | | | | | | | | | | |
| * | | | | | | | | | | | | | | | Deprecate codes for python 3.5Takeshi KOMIYA2020-03-071-2/+1
| | | | | | | | | | | | | | | | |
* | | | | | | | | | | | | | | | | Depart method for node is optionalMartin Hasoň2021-04-091-1/+1
| |_|_|_|_|_|_|_|_|_|_|_|_|_|_|/ |/| | | | | | | | | | | | | | |
* | | | | | | | | | | | | | | | doc: Apply :params: to some APIs in app classTakeshi KOMIYA2021-01-261-55/+69
| |_|_|_|_|_|_|_|_|_|_|_|_|_|/ |/| | | | | | | | | | | | | |
* | | | | | | | | | | | | | | Merge pull request #8744 from tk0miya/refactor_doc4Takeshi KOMIYA2021-01-241-27/+40
|\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ | |_|_|_|_|_|_|_|_|_|_|_|_|_|/ |/| | | | | | | | | | | | | | doc: Apply :params: to some APIs in app class
| * | | | | | | | | | | | | | Update sphinx/application.pyTakeshi KOMIYA2021-01-241-1/+1
| | | | | | | | | | | | | | |
| * | | | | | | | | | | | | | doc: Apply :params: to some APIs in app classTakeshi KOMIYA2021-01-241-27/+40
| | |_|_|_|_|_|_|_|_|_|_|_|/ | |/| | | | | | | | | | | |
* | | | | | | | | | | | | | Fix #8054: Add explanation for types argument of add_config_value()Takeshi KOMIYA2021-01-241-0/+4
|/ / / / / / / / / / / / /
* | | | | | | | | | | | | Close #6241: html: Allow to add JS/CSS files to the specific pageTakeshi KOMIYA2021-01-071-2/+8
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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.
* | | | | | | | | | | | | doc: Add explanation about stable sort of html_*_filesTakeshi KOMIYA2021-01-031-5/+9
| |_|_|_|_|_|_|_|_|_|_|/ |/| | | | | | | | | | |
* | | | | | | | | | | | Close #8634: html: Allow to change the order of JS/CSSTakeshi KOMIYA2021-01-021-15/+43
| |_|_|_|_|_|_|_|_|_|/ |/| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | `Sphinx.add_js_file()` and `Sphinx.add_css_file()` take `priority` argument to change the order of JS/CSS files.
* | | | | | | | | | | A happy new year!Takeshi KOMIYA2021-01-011-1/+1
| |_|_|_|_|_|_|_|_|/ |/| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | .. note:: $ find sphinx tests LICENSE doc/conf.py -type f -exec sed -i '' -e 's/2007\-20../2007-2021/' {} \; $ git co sphinx/locale/**/*.js sphinx/templates/epub3/mimetype
* | | | | | | | | | Fix #8398: Fix type annotation for "confdir" of Sphinx.__init__()Takeshi KOMIYA2020-11-131-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | None is allowed to the argument. So it should be "Optional[str]" instead of "str".
* | | | | | | | | | Merge branch '3.3.x' into 3.xTakeshi KOMIYA2020-11-121-2/+2
|\ \ \ \ \ \ \ \ \ \ | |_|_|_|_|_|_|_|_|/ |/| | | | | | | | |
| * | | | | | | | | Put system locale path after the paths specified by configurationDmitry Shachnev2020-11-091-2/+2
| | |_|_|_|_|_|_|/ | |/| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | In Debian, we ship the translation data for Sphinx in the default search path, /usr/share/locale/. When a .mo file is present there, it takes priority over the translation files specified by the configuration, so overriding does not work. This makes test_customize_system_message fail.
* | | | | | | | | Sort imports with isortFrançois Freitag2020-11-111-7/+7
|/ / / / / / / / | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Keep imports alphabetically sorted and their order homogeneous across Python source files. The isort project has more feature and is more active than the flake8-import-order plugin. Most issues caught were simply import ordering from the same module. Where imports were purposefully placed out of order, tag with isort:skip.
* | | | | | | | Merge pull request #8281 from tk0miya/8073_update_directive_exampleTakeshi KOMIYA2020-10-061-4/+5
|\ \ \ \ \ \ \ \ | | | | | | | | | | | | | | | | | | docs: Fix an example for add_directive()