Skip to content

Commit 230be63

Browse files
committed
Update documentation formatting
Use newer doc plugins and format consistently
1 parent 1f05c31 commit 230be63

11 files changed

+2345
-2092
lines changed

docs/src/markdown/about/changelog.md

+185-178
Large diffs are not rendered by default.

docs/src/markdown/about/contributing.md

+12-12
Original file line numberDiff line numberDiff line change
@@ -10,23 +10,23 @@ any tier you feel comfortable with. No amount is too little. We also accept one
1010

1111
## Bug Reports
1212

13-
1. Please **read the documentation** and **search the issue tracker** to try and find the answer to your question
14-
**before** posting an issue.
13+
1. Please **read the documentation** and **search the issue tracker** to try and find the answer to your question
14+
**before** posting an issue.
1515

16-
2. When creating an issue on the repository, please provide as much information as possible:
16+
2. When creating an issue on the repository, please provide as much information as possible:
1717

18-
- Version being used.
19-
- Operating system.
20-
- Version of Python.
21-
- Errors in console.
22-
- Detailed description of the problem.
23-
- Examples for reproducing the error. You can post pictures, but if specific text or code is required to reproduce
24-
the issue, please provide the text in a plain text format for easy copy/paste.
18+
- Version being used.
19+
- Operating system.
20+
- Version of Python.
21+
- Errors in console.
22+
- Detailed description of the problem.
23+
- Examples for reproducing the error. You can post pictures, but if specific text or code is required to
24+
reproduce the issue, please provide the text in a plain text format for easy copy/paste.
2525

2626
The more info provided the greater the chance someone will take the time to answer, implement, or fix the issue.
2727

28-
3. Be prepared to answer questions and provide additional information if required. Issues in which the creator refuses
29-
to respond to follow up questions will be marked as stale and closed.
28+
3. Be prepared to answer questions and provide additional information if required. Issues in which the creator refuses
29+
to respond to follow up questions will be marked as stale and closed.
3030

3131
## Reviewing Code
3232

docs/src/markdown/about/development.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -29,11 +29,11 @@ When writing code, the code should roughly conform to PEP8 and PEP257 suggestion
2929
linter (with some additional plugins) to ensure code conforms (give or take some of the rules). When in doubt, follow
3030
the formatting hints of existing code when adding files or modifying existing files. Listed below are the modules used:
3131

32-
- @gitlab:pycqa/flake8
33-
- @gitlab:pycqa/flake8-docstrings
34-
- @gitlab:pycqa/pep8-naming
35-
- @ebeweber/flake8-mutable
36-
- @gforcada/flake8-builtins
32+
- @gitlab:pycqa/flake8
33+
- @gitlab:pycqa/flake8-docstrings
34+
- @gitlab:pycqa/pep8-naming
35+
- @ebeweber/flake8-mutable
36+
- @gforcada/flake8-builtins
3737

3838
Usually this can be automated with Tox (assuming it is installed): `tox -e lint`.
3939

@@ -42,10 +42,10 @@ Usually this can be automated with Tox (assuming it is installed): `tox -e lint`
4242
Documents are in Markdown (with with some additional syntax provided by extensions) and are converted to HTML via Python
4343
Markdown. If you would like to build and preview the documentation, you must have these packages installed:
4444

45-
- @Python-Markdown/markdown: the Markdown parser.
46-
- @mkdocs/mkdocs: the document site generator.
47-
- @squidfunk/mkdocs-material: a material theme for MkDocs.
48-
- @facelessuser/pymdown-extensions: this Python Markdown extension bundle.
45+
- @Python-Markdown/markdown: the Markdown parser.
46+
- @mkdocs/mkdocs: the document site generator.
47+
- @squidfunk/mkdocs-material: a material theme for MkDocs.
48+
- @facelessuser/pymdown-extensions: this Python Markdown extension bundle.
4949

5050
It is advised that you just install document dependencies with the following as the above list may not include all
5151
document plugins:

docs/src/markdown/api.md

+18-16
Original file line numberDiff line numberDiff line change
@@ -11,25 +11,26 @@ When detecting XHTML, Soup Sieve simply looks to see if the root element of an X
1111
and does not currently look at the `doctype`. If in the future there is a need for stricter XHTML detection, this may
1212
change.
1313

14-
- HTML document types (HTML, HTML5) will have their tag names and attribute names treated without case
15-
sensitivity, like most browsers do.
14+
- HTML document types (HTML, HTML5) will have their tag names and attribute names treated without case
15+
sensitivity, like most browsers do.
1616

17-
- XML document types (including XHTML) will have their tag names and attribute names treated with case sensitivity.
17+
- XML document types (including XHTML) will have their tag names and attribute names treated with case sensitivity.
1818

19-
- HTML5, XHTML and XML documents will have namespaces evaluated per the document's support (provided via the
20-
parser). Some additional configuration is required when using namespaces, see [Namespace](#namespaces) for more
21-
information.
19+
- HTML5, XHTML and XML documents will have namespaces evaluated per the document's support (provided via the
20+
parser). Some additional configuration is required when using namespaces, see [Namespace](#namespaces) for more
21+
information.
2222

23-
!!! tip "Getting Proper Namespaces"
24-
The `html5lib` parser provides proper namespaces for HTML5, but `lxml`'s HTML parser will not. If you need
25-
namespace support for HTML5, consider using `html5lib`.
23+
/// tip | Getting Proper Namespaces
24+
The `html5lib` parser provides proper namespaces for HTML5, but `lxml`'s HTML parser will not. If you need
25+
namespace support for HTML5, consider using `html5lib`.
2626

27-
For XML, the `lxml-xml` parser (`xml` for short) will provide proper namespaces. It is generally suggested that
28-
`lxml-xml` is used to parse XHTML documents to take advantage of namespaces.
27+
For XML, the `lxml-xml` parser (`xml` for short) will provide proper namespaces. It is generally suggested that
28+
`lxml-xml` is used to parse XHTML documents to take advantage of namespaces.
29+
///
2930

30-
- While attribute values are generally treated as case sensitive, HTML5 and HTML treat the `type` attribute
31-
special. The `type` attribute's value is always case insensitive. This is generally how most browsers treat `type`. If
32-
you need `type` to be sensitive, you can use the `s` flag: `#!css [type="submit" s]`.
31+
- While attribute values are generally treated as case sensitive, HTML5 and HTML treat the `type` attribute
32+
special. The `type` attribute's value is always case insensitive. This is generally how most browsers treat `type`.
33+
If you need `type` to be sensitive, you can use the `s` flag: `#!css [type="submit" s]`.
3334

3435
While Soup Sieve access is exposed through Beautiful Soup's API, Soup Sieve's API can always be imported and accessed
3536
directly for more controlled tag selection if needed.
@@ -180,8 +181,9 @@ would normally cause an identifier to be invalid.
180181
'�'
181182
```
182183

183-
!!! new "New in 1.9.0"
184-
`escape` is a new API function added in 1.9.0.
184+
/// new | New in 1.9.0
185+
`escape` is a new API function added in 1.9.0.
186+
///
185187

186188
## `soupsieve.compile()`
187189

docs/src/markdown/index.md

+11-11
Original file line numberDiff line numberDiff line change
@@ -14,17 +14,17 @@ Soup Sieve has implemented most of the CSS selectors up through the latest CSS d
1414
number that don't make sense in a non-browser environment. Selectors that cannot provide meaningful functionality simply
1515
do not match anything. Some of the supported selectors are:
1616

17-
- `#!css .classes`
18-
- `#!css #ids`
19-
- `#!css [attributes=value]`
20-
- `#!css parent child`
21-
- `#!css parent > child`
22-
- `#!css sibling ~ sibling`
23-
- `#!css sibling + sibling`
24-
- `#!css :not(element.class, element2.class)`
25-
- `#!css :is(element.class, element2.class)`
26-
- `#!css parent:has(> child)`
27-
- and [many more](./selectors/index.md)
17+
- `#!css .classes`
18+
- `#!css #ids`
19+
- `#!css [attributes=value]`
20+
- `#!css parent child`
21+
- `#!css parent > child`
22+
- `#!css sibling ~ sibling`
23+
- `#!css sibling + sibling`
24+
- `#!css :not(element.class, element2.class)`
25+
- `#!css :is(element.class, element2.class)`
26+
- `#!css parent:has(> child)`
27+
- and [many more](./selectors/index.md)
2828

2929
## Installation
3030

0 commit comments

Comments
 (0)