Skip to content

Commit 8185714

Browse files
committed
docs: use bulleted list for deprecation; pydoc for shared dir
pydoc update for embedded/released docs isn't working quite right. The html file is generated but no docs are extracted into it. But the error emitted by the presence of pydoc.txt is suppressed.
1 parent 23e391f commit 8185714

File tree

3 files changed

+17
-8
lines changed

3 files changed

+17
-8
lines changed

doc/customizing.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ caches the schema).
9090
<td tal:content="structure context/due_date/field" />
9191
</tr>
9292

93-
If you want to show only the date part of due_date then do this instead:
93+
If you want to show only the date part of due_date then do this instead::
9494

9595
<tr>
9696
<th>Due Date</th>

doc/index.txt

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ Contents
1313

1414
.. toctree::
1515
:maxdepth: 2
16+
:includehidden:
1617

1718
features
1819

@@ -50,6 +51,11 @@ Contents
5051
Richard Jones implementation notes <implementation>
5152
security-history
5253

54+
.. toctree::
55+
:hidden:
56+
57+
pydoc
58+
5359
See: https://wiki.roundup-tracker.org/ReleaseErrata for fixes to
5460
documentation.
5561

doc/upgrading.txt

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,8 @@ Repeat for each tracker instance.
4747
Python v2.5 and v2.6. Starting with the v1.6 releases of Roundup
4848
Python version 2.7 that is newer than 2.7.2 is required to run
4949
Roundup. Starting with Roundup version 2.0.0 we also support Python 3
50-
versions newer than 3.6.
50+
versions newer than 3.6. Roundup version 2.5 supports Python
51+
3.7 and newer.
5152

5253
Recent release notes have the following labels:
5354

@@ -100,13 +101,15 @@ Contents:
100101
Migrating from 2.4.0 to 2.5.0
101102
=============================
102103

103-
Deprecation Notices (info)
104-
--------------------------
104+
Deprecation Notices (required)
105+
------------------------------
105106

106-
Support for SQLite version 2 has been removed in 2.5.0. Support for
107-
the `PySQLite <https://github.com/ghaering/pysqlite>`_ library has
108-
been removed in 2.5.0. Only the Python supplied sqlite3 library will
109-
be supported.
107+
* Support for SQLite version 2 has been removed in 2.5.0.
108+
* Support for the `PySQLite <https://github.com/ghaering/pysqlite>`_
109+
library has been removed in 2.5.0. Only the Python supplied
110+
sqlite3 library is supported.
111+
* Roundup 2.5.0 supports Python 3.7 or newer. (It is not tested
112+
on Python 3.6. It may work but we don;t support it.)
110113

111114
Update responsive template _generic.404.html and query.item.html (recommended)
112115
------------------------------------------------------------------------------

0 commit comments

Comments
 (0)