Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/source/contents.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ Table of contents
ref/index
howto/index
faq
known-issues
releases/index
internals

Expand Down
6 changes: 4 additions & 2 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ First steps
- :doc:`Installation <intro/install>`
- :doc:`Configuring a project <intro/configure>`
- :doc:`howto/contrib-apps`
- :doc:`topics/known-issues`
- :doc:`known-issues`

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

- Looking for specific information? Try the :ref:`genindex`, :ref:`modindex`,
or the detailed :doc:`table of contents <contents>`.
:doc:`topics section <topics/index>` or detailed :doc:`table of contents
<contents>`.
Comment on lines 26 to +28
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nor is the reference material mentioned. This text was ripped straight from Django's documentation. I don't think we need to mention every section here.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We don't need to mention every section and at first I had it in its own bullet but decided to include "topics" in a bullet about topics. 😄

Also I'm only calling out personal annoyances, not necessarily looking to symmetrize the entire docs.

Lastly, copying from Django is fine but only gets us so far.


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

Expand Down Expand Up @@ -74,5 +75,6 @@ Miscellaneous
ref/index
howto/index
faq
known-issues
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You didn't follow the instructions above: .. Keep this toctree in sync with contents.rst.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

? You mean the ordering?

releases/index
internals
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
============================
Known issues and limitations
============================
============
Known issues
============

This document summarizes some known issues and limitations of this library.
If you notice an issue not listed, use the :ref:`issue-tracker` to report a bug
Expand Down
1 change: 0 additions & 1 deletion docs/source/topics/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,3 @@ know:

embedded-models
transactions
known-issues