From 696f00684418bc08cdce90c300a6b186a114f927 Mon Sep 17 00:00:00 2001 From: Jesse Wei Date: Thu, 17 Aug 2023 13:38:45 -0400 Subject: [PATCH] Small changes --- docs/libraries.rst | 10 ++-------- docs/markdown_test.md | 2 +- 2 files changed, 3 insertions(+), 9 deletions(-) diff --git a/docs/libraries.rst b/docs/libraries.rst index b8c7526..337adbd 100644 --- a/docs/libraries.rst +++ b/docs/libraries.rst @@ -512,9 +512,9 @@ to be discovered. See `this page `_ to view our auto-generated doc Edit site ========= -You can write site content in Markdown instead of RST via `MyST Parser `_, 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 `_, which is the homepage. +After creating a new file, index it by adding it to `docs/index.rst `_, which is the homepage. To learn RST, see the `source code <_sources/libraries.rst.txt>`_ for this page and ``_. @@ -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. @@ -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 `_, -which is the homepage, or `docs/libraries.rst `_, which -is this page. `Documentation `_ for `source code <_modules/index.html>`_ is automatically generated. - Now follow the Read the Docs tutorial starting from `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 `_ and diff --git a/docs/markdown_test.md b/docs/markdown_test.md index cf3d75a..17515e2 100644 --- a/docs/markdown_test.md +++ b/docs/markdown_test.md @@ -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}