Skip to content

Commit 83bce5c

Browse files
Ken KundertKen Kundert
authored andcommitted
loosen requirements.txt for documentation
1 parent 31a8097 commit 83bce5c

7 files changed

Lines changed: 20 additions & 155 deletions

File tree

doc/minimal-nestedtext.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
Minimal NestedText
55
******************
66

7-
*Minimal NestedText* is *NestedText* without support for multi-line keys and
7+
*Minimal NestedText* is *NestedText* without support for multiline keys and
88
inline dictionaries and lists.
99

1010
*Minimal NestedText* is a subset of *NestedText* that foregoes some of the
@@ -81,8 +81,8 @@ describe to your users if you decide to use it for your application.
8181

8282
Indentation is used to denote nesting. In this case the colon or dash is
8383
the last character on the line and is followed by an indented value. The
84-
value may be a collection of name-value pairs, a list, or a multi-line
85-
string. Every line of a multi-line string is introduced by a greater-than
84+
value may be a collection of name-value pairs, a list, or a multiline
85+
string. Every line of a multiline string is introduced by a greater-than
8686
symbol followed by a space or newline.
8787

8888
.. code-block:: nestedtext

doc/philosophy.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ as in::
101101
If one had to choose one format to use every time, one would generally choose
102102
the second because it is more natural for keyed lists.
103103

104-
However, there are more issues. Imagine that the multi-line text is indented.
104+
However, there are more issues. Imagine that the multiline text is indented.
105105
How would that be indicated? Or perhaps there are leading or trailing blank
106106
lines, how would those be distinguished from the empty space used to make our
107107
list more readable. To resolve these issues, *NestedText* deviates from normal

doc/related_projects.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -110,6 +110,16 @@ Ruby
110110
Supports :ref:`NestedText v3.0 <v3.0>`.
111111

112112

113+
Rust
114+
""""
115+
116+
`nested-text <https://github.com/hansstimer/nested-text>`_
117+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
118+
119+
`Rust <https://www.rust-lang.org>`_ implementation of *NestedText* with
120+
serde integration. Supports :ref:`NestedText v3.8 <v3.8>`.
121+
122+
113123
Zig
114124
"""
115125

doc/releases.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ v3.8 (2025-12-26)
2222

2323
**Bug Fixes**:
2424

25-
- Catch multi-line key not followed by indented value.
25+
- Catch multiline key not followed by indented value.
2626
- Make line-ending recognition consistent for files and strings.
2727
- Fix bug in :func:`get_value()`.
2828
- Report error if there is content that follows top-level inline dictionary.

doc/requirements.in

Lines changed: 0 additions & 6 deletions
This file was deleted.

doc/requirements.txt

Lines changed: 4 additions & 143 deletions
Original file line numberDiff line numberDiff line change
@@ -1,143 +1,4 @@
1-
#
2-
# This file is autogenerated by pip-compile with Python 3.12
3-
# by the following command:
4-
#
5-
# pip-compile ./requirements.in
6-
#
7-
alabaster==0.7.13
8-
# via sphinx
9-
apeye==1.4.1
10-
# via sphinx-toolbox
11-
apeye-core==1.1.4
12-
# via apeye
13-
autoclasstoc==1.6.0
14-
# via -r ./requirements.in
15-
autodocsumm==0.2.11
16-
# via sphinx-toolbox
17-
babel==2.13.1
18-
# via sphinx
19-
beautifulsoup4==4.12.2
20-
# via sphinx-toolbox
21-
cachecontrol[filecache]==0.13.1
22-
# via sphinx-toolbox
23-
certifi==2023.11.17
24-
# via requests
25-
charset-normalizer==3.3.2
26-
# via requests
27-
cssutils==2.9.0
28-
# via dict2css
29-
dict2css==0.3.0.post1
30-
# via sphinx-toolbox
31-
docutils==0.16
32-
# via
33-
# -r ./requirements.in
34-
# autoclasstoc
35-
# sphinx
36-
# sphinx-rtd-theme
37-
# sphinx-tabs
38-
# sphinx-toolbox
39-
domdf-python-tools==3.7.0
40-
# via
41-
# apeye
42-
# apeye-core
43-
# dict2css
44-
# sphinx-toolbox
45-
filelock==3.13.1
46-
# via
47-
# cachecontrol
48-
# sphinx-toolbox
49-
html5lib==1.1
50-
# via sphinx-toolbox
51-
idna==3.6
52-
# via
53-
# apeye-core
54-
# requests
55-
imagesize==1.4.1
56-
# via sphinx
57-
jinja2==3.1.2
58-
# via
59-
# sphinx
60-
# sphinx-jinja2-compat
61-
markupsafe==2.1.3
62-
# via
63-
# jinja2
64-
# sphinx-jinja2-compat
65-
more-itertools==10.1.0
66-
# via autoclasstoc
67-
msgpack==1.0.7
68-
# via cachecontrol
69-
natsort==8.4.0
70-
# via domdf-python-tools
71-
packaging==23.2
72-
# via sphinx
73-
platformdirs==4.1.0
74-
# via apeye
75-
pygments==2.17.2
76-
# via
77-
# sphinx
78-
# sphinx-prompt
79-
# sphinx-tabs
80-
requests==2.31.0
81-
# via
82-
# apeye
83-
# cachecontrol
84-
# sphinx
85-
ruamel-yaml==0.18.5
86-
# via sphinx-toolbox
87-
ruamel-yaml-clib==0.2.8
88-
# via ruamel-yaml
89-
six==1.16.0
90-
# via html5lib
91-
snowballstemmer==2.2.0
92-
# via sphinx
93-
soupsieve==2.5
94-
# via beautifulsoup4
95-
sphinx==5.3.0
96-
# via
97-
# autoclasstoc
98-
# autodocsumm
99-
# sphinx-autodoc-typehints
100-
# sphinx-prompt
101-
# sphinx-rtd-theme
102-
# sphinx-tabs
103-
# sphinx-toolbox
104-
# sphinxcontrib-jquery
105-
sphinx-autodoc-typehints==1.23.0
106-
# via sphinx-toolbox
107-
sphinx-jinja2-compat==0.2.0.post1
108-
# via sphinx-toolbox
109-
sphinx-prompt==1.5.0
110-
# via sphinx-toolbox
111-
sphinx-rtd-theme==2.0.0
112-
# via -r ./requirements.in
113-
sphinx-tabs==3.4.5
114-
# via sphinx-toolbox
115-
sphinx-toolbox==3.5.0
116-
# via -r ./requirements.in
117-
sphinxcontrib-applehelp==1.0.8
118-
# via sphinx
119-
sphinxcontrib-devhelp==1.0.6
120-
# via sphinx
121-
sphinxcontrib-htmlhelp==2.0.5
122-
# via sphinx
123-
sphinxcontrib-jquery==4.1
124-
# via sphinx-rtd-theme
125-
sphinxcontrib-jsmath==1.0.1
126-
# via sphinx
127-
sphinxcontrib-qthelp==1.0.7
128-
# via sphinx
129-
sphinxcontrib-serializinghtml==1.1.10
130-
# via sphinx
131-
tabulate==0.9.0
132-
# via sphinx-toolbox
133-
typing-extensions==4.9.0
134-
# via
135-
# domdf-python-tools
136-
# sphinx-toolbox
137-
urllib3==2.1.0
138-
# via requests
139-
webencodings==0.5.1
140-
# via html5lib
141-
142-
# The following packages are considered to be unsafe in a requirements file:
143-
# setuptools
1+
autoclasstoc >= 1.6
2+
docutils
3+
sphinx_toolbox
4+
sphinx_rtd_theme

doc/techniques.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -517,7 +517,7 @@ Long Lines
517517

518518
One of the benefits of *NestedText* is that no escaping of special characters is
519519
ever needed. However, you might find it helpful to add your own support for
520-
removing escaped newlines in multi-line strings. Doing so allows you to keep
520+
removing escaped newlines in multiline strings. Doing so allows you to keep
521521
your lines short in the source document so as to make them easier to interpret
522522
in windows of limited width.
523523

0 commit comments

Comments
 (0)