Skip to content

Commit d767c80

Browse files
committed
Doc fixes
- Move known-issues to the top level - Add topics section to bullet point about finding specific topics
1 parent 89bc095 commit d767c80

File tree

4 files changed

+8
-6
lines changed

4 files changed

+8
-6
lines changed

docs/source/contents.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ Table of contents
1414
ref/index
1515
howto/index
1616
faq
17+
known-issues
1718
releases/index
1819
internals
1920

docs/source/index.rst

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ First steps
1414
- :doc:`Installation <intro/install>`
1515
- :doc:`Configuring a project <intro/configure>`
1616
- :doc:`howto/contrib-apps`
17-
- :doc:`topics/known-issues`
17+
- :doc:`known-issues`
1818

1919
Getting help
2020
============
@@ -24,7 +24,8 @@ Having trouble? We’d like to help!
2424
- Try the :doc:`faq` – it’s got answers to many common questions.
2525

2626
- Looking for specific information? Try the :ref:`genindex`, :ref:`modindex`,
27-
or the detailed :doc:`table of contents <contents>`.
27+
:doc:`topics section <topics/index>` or detailed :doc:`table of contents
28+
<contents>`.
2829

2930
- The :doc:`howto/index` section has step-by-step guides for common tasks.
3031

@@ -74,5 +75,6 @@ Miscellaneous
7475
ref/index
7576
howto/index
7677
faq
78+
known-issues
7779
releases/index
7880
internals

docs/source/topics/known-issues.rst renamed to docs/source/known-issues.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
============================
2-
Known issues and limitations
3-
============================
1+
============
2+
Known issues
3+
============
44

55
This document summarizes some known issues and limitations of this library.
66
If you notice an issue not listed, use the :ref:`issue-tracker` to report a bug

docs/source/topics/index.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,4 +10,3 @@ know:
1010

1111
embedded-models
1212
transactions
13-
known-issues

0 commit comments

Comments
 (0)