summaryrefslogtreecommitdiff
path: root/doc/development
Commit message (Collapse)AuthorAgeFilesLines
* Remove deprecated ``style`` key for HTML templates (#11381)Adam Turner2023-04-281-16/+0
|
* Revert "Support and prefer ``.jinja`` to ``_t`` for static templates ↵James Addison2023-04-231-42/+4
| | | | | (#11165)" (#11329) This reverts commit 5d13215b58f93c6be8255ef2e3e20836508c7d47.
* Add a missing word in ``doc/development/theming.rst`` (#11301)James Addison2023-04-071-1/+1
|
* Support and prefer ``.jinja`` to ``_t`` for static templates (#11165)James Addison2023-04-071-4/+42
| | | Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
* Enable 'nit-picky mode' for Sphinx's documentationAdam Turner2023-04-065-11/+12
| | | | | Fix several reference errors throughout the documentation and set ``nitpick_ignore`` in ``doc/conf.py``.
* Fix COM812Adam Turner2023-02-182-3/+3
|
* Documentation reshuffle (#11112)Adam Turner2023-01-083-4/+499
|
* Run pyupgrade (#11070)Adam Turner2023-01-021-1/+1
|
* Use PEP 604 typesAdam Turner2023-01-011-2/+2
|
* Insert ``from __future__ import annotations``Adam Turner2023-01-011-0/+2
|
* Copy edit the tutorial (#11049)mikemckiernan2022-12-291-6/+7
| | | | | | - Correct two typos. - Include the ingredient index in the "for example" statement. It's tedious, but the audience is reading to learn.
* Fix example using ``add_config_value`` (#10937)Martin Liška2022-12-201-1/+1
| | | ``add_config_value()`` has mandatory 3 arguments.
* Run the ``pyupgrade`` toolAdam Turner2022-10-171-2/+2
|
* Begin addding `flake8-simplify` checks (#10820)danieleades2022-09-201-2/+1
| | | | Start with SIM104 and ignore all other flake8-simplify warnings
* Update doc/development/tutorials/helloworld.rstAdam Turner2022-08-071-1/+1
|
* Fix small typo in extension hello world tutorialDavid Stansby2022-08-041-1/+1
|
* Fix flake8 5.0.0 reported formatting errorsdaniel.eades2022-08-011-1/+1
|
* Allow specifying multiple CSS files in themes (#10465)Takeshi KOMIYA2022-07-171-4/+7
| | | Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
* Replace doclinter with sphinx-lint (#10389)Julien Palard2022-06-162-6/+4
| | | Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
* doc: Fix syntax errorTakeshi KOMIYA2022-05-221-2/+2
| | | Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
* Fix #10344: docs: Update explanation for copying static files manuallyTakeshi KOMIYA2022-05-151-5/+5
|
* Merge pull request #10345 from ↵Takeshi KOMIYA2022-05-031-1/+1
|\ | | | | | | | | Thecarisma/fix-theming-add-static-file-documentation Refractor the example in 'Add your own static files to the build assets' documentation section
| * Fix the example in 'Add your own static files to the build assets' ↵Adewale Azeez2022-04-141-1/+1
| | | | | | | | documentation section
* | Use `Node.findall`Adam Turner2022-04-221-2/+2
| |
* | `rawsource` is deprecated in `docutils.nodes.Text`Adam Turner2022-04-221-2/+2
|/
* setup -> set upDaniel Townsend2022-02-101-1/+1
|
* improve grammar in theming.rstDaniel Townsend2022-02-081-2/+2
|
* Update recipe.pydanieleades2022-01-141-1/+1
|
* address some unused loop control variables (B007)Daniel Eades2022-01-121-1/+1
|
* doc: Use "console" for the highlight language of console outputTakeshi KOMIYA2021-12-131-2/+2
| | | | | Using "console" language is better for the console example (including command-line prompt)
* doc: Improve autodoc extension exampleJouke Witteveen2021-12-061-5/+4
| | | Enumerations can have aliases, which should be documented as well.
* doc: Fix autodoc extension exampleJouke Witteveen2021-12-021-2/+5
| | | | | | `directivetype` is set to mimic `ClassDocumenter`. Reflect that. `isinstance` would work on the enum members, but that is not what we want here. `issubclass` raises a TypeError when called on objects that are not classes.
* Fix #9525: tutorial: Wrong condition in recipe.pyTakeshi KOMIYA2021-08-051-1/+1
|
* Update docs for themingFrank Yu2021-07-031-0/+3
|
* doc: Fix docslint misunderstanding scope of code-blocksTakeshi KOMIYA2021-06-061-3/+3
|
* doc: Upgrade docutils.sourceforge.io links to HTTPSigo958622021-05-163-7/+7
| | | | | Also change any docutils.sourceforge.net link to io top level domain.
* doc: Added reflink to autodoc tutorialigo958622021-03-091-0/+2
| | | | Used in add_autodocumenter docstring
* doc: Added autodoc extension tutorial to tutorials indexigo958622021-03-091-0/+2
|
* doc: Create autodoc extension tutorialigo958622021-03-092-0/+192
|
* Merge pull request #8873 from tk0miya/8860_bad_exampleTakeshi KOMIYA2021-02-131-3/+3
|\ | | | | Fix #8860: doc: Usage of recipe directive is wrong
| * Fix #8860: doc: Usage of recipe directive is wrongTakeshi KOMIYA2021-02-121-3/+3
| |
* | Fix #8860: doc: recipe directive crashes with AttributeErrorTakeshi KOMIYA2021-02-111-1/+1
|/ | | | | | The pre check in the `ReceipeDirective.add_target_and_index() was wrong. It checkes non-existing option "noindex", but it should check "contains" option instead.
* doc: Link to detailed extension documentationmarkus-oehme-pg402021-01-221-4/+6
| | | I missed that there are actually two sections explaining extensions in the docs and just saw the examples based one. This lead to me thinking "kind of lousy documentation, but that's probably par for the course". Would there have been a pointer to the detailed extension API description it would have saved me hours of guesswork.
* Sort imports with isortFrançois Freitag2020-11-111-2/+1
| | | | | | | | | | | | 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.
* moving extension dev overviewChris Holdgraf2020-07-293-4/+1
|
* commentsChris Holdgraf2020-07-291-0/+20
|
* rearranging a few docs and small updatesChris Holdgraf2020-07-295-22/+44
|
* Update doc/development/tutorials/builders.rstChris Holdgraf2020-07-291-1/+1
|
* flake8Chris Holdgraf2020-07-291-3/+3
|
* several documentation improvements to theming, templating, and extension ↵Chris Holdgraf2020-07-294-0/+374
| | | | development