Skip to content

Commit

Permalink
Small changes
Browse files Browse the repository at this point in the history
  • Loading branch information
Jesse Wei authored and Jesse Wei committed Aug 17, 2023
1 parent 0d55cb3 commit 696f006
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 9 deletions.
10 changes: 2 additions & 8 deletions docs/libraries.rst
Original file line number Diff line number Diff line change
Expand Up @@ -512,9 +512,9 @@ to be discovered. See `this page <modules.html>`_ to view our auto-generated doc
Edit site
=========

You can write site content in Markdown instead of RST via `MyST Parser <https://myst-parser.readthedocs.io/en/latest/>`_, while still retaining the ability to write raw RST in the Markdown file for extra functionality that Markdown doesn't provide. See :ref:`markdown-test` for an example. This page was written in RST, unfortunately, since I didn't find out until after this project was complete.
You can write site content in Markdown instead of RST. See :ref:`markdown-test` for an example and further instructions. This page was written in RST, unfortunately, since I didn't find out until after this project was completed.

After creating a new file, add it to `docs/index.rst <https://github.com/NIRALUser/NeuroRuler/blob/main/docs/index.rst>`_, which is the homepage.
After creating a new file, index it by adding it to `docs/index.rst <https://github.com/NIRALUser/NeuroRuler/blob/main/docs/index.rst>`_, which is the homepage.

To learn RST, see the `source code <_sources/libraries.rst.txt>`_
for this page and `<https://thomas-cokelaer.info/tutorials/sphinx/rest_syntax.html>`_.
Expand All @@ -525,8 +525,6 @@ Steps for setting up from scratch
=================================

.. note:: This does not have to be done for the NR repo since setup is already complete.
It's mostly here for my reference since there's not a lot of information about this process online and I'd forget
how to do it.

Your current working directory should be whatever repo you want to automatically generate documentation for. If you just need a local documentation site and not a public one via ReadTheDocs, skip instructions regarding ReadTheDocs.

Expand Down Expand Up @@ -562,10 +560,6 @@ You can open it in a web browser [#macos_open_html]_ to check it out before push
website. From now on, you can just run :code:`make html` to update the html pages. You don't need to run
:code:`sphinx-apidoc` unless you create a new package.

You can edit `docs/index.rst <https://github.com/NIRALUser/NeuroRuler/blob/main/docs/index.rst>`_,
which is the homepage, or `docs/libraries.rst <https://github.com/NIRALUser/NeuroRuler/blob/main/docs/libraries.rst>`_, which
is this page. `Documentation <modules.html>`_ for `source code <_modules/index.html>`_ is automatically generated.

Now follow the Read the Docs tutorial starting from `Sign up for Read the Docs <https://docs.readthedocs.io/en/stable/tutorial/#sign-up-for-read-the-docs>`_.
You can end at Checking the first build. To set up CDD (continuous documentation deployment), check
`Permissions for connected accounts <https://docs.readthedocs.io/en/stable/guides/git-integrations.html>`_ and
Expand Down
2 changes: 1 addition & 1 deletion docs/markdown_test.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

```{topic} Overview
This page is generated from a Markdown file via [MyST Parser](https://myst-parser.readthedocs.io/en/latest/) and also contains raw RST for extra functionality (i.e., Markdown suffices, and RST is not necessary). To view the source code for this page, click the "View page source" button at the top right.
This page is generated from a Markdown file via [MyST Parser](https://myst-parser.readthedocs.io/en/latest/) and also contains raw RST for extra functionality (i.e., Markdown suffices, and RST is not necessary). To view the source code for this page, click the "Edit on GitHub" button at the top right.
```

```{contents}
Expand Down

0 comments on commit 696f006

Please sign in to comment.