Skip to content

Commit

Permalink
Replace index.md with intro.md
Browse files Browse the repository at this point in the history
Fixes #6
  • Loading branch information
benjaoming authored Feb 12, 2024
1 parent bdbc57b commit acf41b7
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -57,8 +57,8 @@ If you are copying this code in order to get started with your documentation, yo

#. use your existing project repository or create a new repository on GitHub, GitLab, Bitbucket or another host supported by Read the Docs
#. copy ``.readthedocs.yaml`` and the ``docs/`` folder into your project.
#. if you want to have a README on GitHub, create a ``README.rst`` which will be included in ``index.md``.
#. if you *do not* want your README from GitHub included in the docs, edit `ìndex.md`` and remove the ``eval-rst`` block that includes it.
#. if you want to have a README on GitHub, create a ``README.rst`` which will be included in ``intro.md``.
#. if you *do not* want your README from GitHub included in the docs, edit ``intro.md`` and remove the ``eval-rst`` block that includes it.
#. if you don't already have a ``.gitignore``, use the one from the project file -- otherwise add these lines::

/docs/conf.py
Expand Down

0 comments on commit acf41b7

Please sign in to comment.