66 Commits

Author	SHA1	Message	Date
Adam Turner	670bcb743b	Documentation reshuffle (#11112)	2023-01-08 13:52:36 +00:00
Adam Turner	4032070e81	Run pyupgrade (#11070)	2023-01-02 00:01:14 +00:00
Adam Turner	14a9289d78	Use PEP 604 types	2023-01-01 20:48:39 +00:00
Adam Turner	f4c8a0a68e	Insert `from __future__ import annotations`	2023-01-01 20:48:37 +00:00
mikemckiernan	32bce8fb7c	Copy edit the tutorial (#11049) ... - Correct two typos. - Include the ingredient index in the "for example" statement. It's tedious, but the audience is reading to learn.	2022-12-29 13:58:32 +00:00
Martin Liška	9844162473	Fix example using `add_config_value` (#10937) ... ``add_config_value()`` has mandatory 3 arguments.	2022-12-20 13:15:00 +00:00
Adam Turner	920828fe35	Run the `pyupgrade` tool	2022-10-17 22:39:09 +01:00
danieleades	276f430b57	Begin addding flake8-simplify checks (#10820) ... Start with SIM104 and ignore all other flake8-simplify warnings	2022-09-20 21:30:31 +01:00
Adam Turner	7ef46150d1	Update doc/development/tutorials/helloworld.rst	2022-08-07 10:16:39 +01:00
David Stansby	26ca57893d	Fix small typo in extension hello world tutorial	2022-08-04 16:48:24 +01:00
daniel.eades	964fcb2e07	Fix flake8 5.0.0 reported formatting errors	2022-08-01 20:55:47 +02:00
Takeshi KOMIYA	e7fc03bce2	Allow specifying multiple CSS files in themes (#10465) ... Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>	2022-07-17 12:27:43 +01:00
Julien Palard	956cddb7d4	Replace doclinter with sphinx-lint (#10389) ... Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>	2022-06-16 19:32:09 +01:00
Takeshi KOMIYA	e6f07c7381	doc: Fix syntax error ... Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>	2022-05-22 13:34:21 +09:00
Takeshi KOMIYA	c63d4741e9	Fix #10344: docs: Update explanation for copying static files manually	2022-05-15 23:38:01 +09:00
Takeshi KOMIYA	e4f78df2fc	Merge pull request #10345 from Thecarisma/fix-theming-add-static-file-documentation ... Refractor the example in 'Add your own static files to the build assets' documentation section	2022-05-03 02:10:57 +09:00
Adam Turner	35ed39c946	Use Node.findall	2022-04-22 04:21:39 +01:00
Adam Turner	cbe0c99181	rawsource is deprecated in docutils.nodes.Text	2022-04-22 04:21:38 +01:00
Adewale Azeez	02074f8ed4	Fix the example in 'Add your own static files to the build assets' documentation section	2022-04-14 01:52:37 +01:00
Daniel Townsend	bcb0a03f92	setup -> set up	2022-02-10 17:44:18 +00:00
Daniel Townsend	03c8ceb85f	improve grammar in theming.rst	2022-02-08 13:05:18 +00:00
danieleades	9c68cd12d7	Update recipe.py	2022-01-14 08:58:54 +00:00
Daniel Eades	6697ed62ed	address some unused loop control variables (B007)	2022-01-12 20:19:18 +00:00
Takeshi KOMIYA	dd27e35e4c	doc: Use "console" for the highlight language of console output ... Using "console" language is better for the console example (including command-line prompt)	2021-12-13 14:20:37 +09:00
Jouke Witteveen	e200e7b7c1	doc: Improve autodoc extension example ... Enumerations can have aliases, which should be documented as well.	2021-12-06 12:31:09 +01:00
Jouke Witteveen	bc849e2170	doc: Fix autodoc extension example ... `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.	2021-12-02 16:50:09 +01:00
Takeshi KOMIYA	c1692faba7	Fix #9525: tutorial: Wrong condition in recipe.py	2021-08-05 01:38:58 +09:00
Frank Yu	da00466081	Update docs for theming	2021-07-03 00:44:10 +08:00
Takeshi KOMIYA	e0500f7354	doc: Fix docslint misunderstanding scope of code-blocks	2021-06-06 13:24:06 +09:00
igo95862	e67c9e5df1	doc: Upgrade docutils.sourceforge.io links to HTTPS ... Also change any docutils.sourceforge.net link to io top level domain.	2021-05-16 15:53:49 +03:00
igo95862	7ee2000598	doc: Added reflink to autodoc tutorial ... Used in add_autodocumenter docstring	2021-03-09 17:57:30 +03:00
igo95862	a56f69b916	doc: Added autodoc extension tutorial to tutorials index	2021-03-09 17:57:30 +03:00
igo95862	1ac05a2a83	doc: Create autodoc extension tutorial	2021-03-09 17:56:46 +03:00
Takeshi KOMIYA	61af7f48ad	Merge pull request #8873 from tk0miya/8860_bad_example ... Fix #8860: doc: Usage of recipe directive is wrong	2021-02-13 01:04:27 +09:00
Takeshi KOMIYA	d5de7bf3cf	Fix #8860: doc: Usage of recipe directive is wrong	2021-02-12 20:51:53 +09:00
Takeshi KOMIYA	f17ab57b64	Fix #8860: doc: recipe directive crashes with AttributeError ... 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.	2021-02-11 22:13:07 +09:00
markus-oehme-pg40	e59365923b	doc: Link to detailed extension documentation ... 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.	2021-01-22 09:29:19 +01:00
François Freitag	0949735210	Sort imports with isort ... 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.	2020-11-11 13:19:05 +01:00
Chris Holdgraf	b8ee3ac9a4	moving extension dev overview	2020-07-29 10:38:18 +01:00
Chris Holdgraf	84f7dffd99	comments	2020-07-29 10:38:18 +01:00
Chris Holdgraf	c7085162d1	rearranging a few docs and small updates	2020-07-29 10:38:18 +01:00
Chris Holdgraf	924befa07e	Update doc/development/tutorials/builders.rst	2020-07-29 10:38:18 +01:00
Chris Holdgraf	729dcd0e03	flake8	2020-07-29 10:38:18 +01:00
Chris Holdgraf	60b105d6aa	several documentation improvements to theming, templating, and extension development	2020-07-29 10:38:18 +01:00
Julien Palard	418576ddd1	Doc: Add missing 'env-merge-info' to the todo tutorial.	2020-07-06 17:55:55 +02:00
Julien Palard	527a0361f1	FIX: Typo in tutorial/todo.	2020-06-30 17:13:19 +02:00
Stephen Finucane	f07ad49c22	docs: Add usage, development index page ... Signed-off-by: Stephen Finucane <stephen@that.guru>	2020-05-30 15:24:40 +01:00
Takeshi KOMIYA	8090e9040f	Fix #7299: doc: Fix TODO tutorial	2020-03-15 18:33:41 +09:00
Takeshi KOMIYA	9db38aadfd	Fix #3106: domain: Register hyperlink target for index page automatically	2020-02-22 18:20:12 +09:00
Takeshi KOMIYA	c97218cc97	doc: Fix file inclusion in recipe tutorial has been broken	2020-02-17 01:20:59 +09:00