Skip to content

Commit

Permalink
move toc IQSS#10531
Browse files Browse the repository at this point in the history
  • Loading branch information
pdurbin committed Jun 13, 2024
1 parent b080842 commit 55ce252
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 17 deletions.
16 changes: 16 additions & 0 deletions doc/sphinx-guides/source/contributor/documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,3 +26,19 @@ Please observe the following when writing documentation:
- Break up longer paragraphs.
- Use "double quotes" instead of 'single quotes'.
- Favor "and" (data and code) over slashes (data/code).

## Table of Contents

Every non-index page should use the following code to display a table of contents of internal sub-headings. This code should be placed below any introductory text and directly above the first subheading, much like a Wikipedia page.

If the page is written in reStructuredText (.rst), use this form:

.. contents:: |toctitle|
:local:

If the page is written in Markdown (.md), use this form:

```{contents} Contents:
:local:
:depth: 3
```
17 changes: 0 additions & 17 deletions doc/sphinx-guides/source/developers/documentation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -106,23 +106,6 @@ You can click on the files in the ``html`` folder to preview the changes.

Now you can make a commit with the changes to your own fork in GitHub and submit a pull request. See :ref:`how-to-make-a-pull-request`.

Table of Contents
-----------------

Every non-index page should use the following code to display a table of contents of internal sub-headings: ::

.. contents:: |toctitle|
:local:

This code should be placed below any introductory text/images and directly above the first subheading, much like a Wikipedia page.

If you are using Markdown, you should use this form instead: ::

```{contents} Contents:
:local:
:depth: 3
```

Images
------

Expand Down

0 comments on commit 55ce252

Please sign in to comment.