Skip to content
This repository was archived by the owner on Jun 7, 2023. It is now read-only.

Commit 7657240

Browse files
author
Brad Miller
committed
Cannot use raw in README on pypi
1 parent bba25ae commit 7657240

1 file changed

Lines changed: 5 additions & 6 deletions

File tree

README.rst

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Packaging of the Runestone components for publishing educational materials using
1818
Documentation
1919
-------------
2020

21-
You will find the new Authors Guide `here <https://runestone.academy/runestone/static/authorguide/index.html>`_
21+
You will find the new `Authors Guide <https://runestone.academy/runestone/static/authorguide/index.html>`_
2222

2323
If you want to report any issues with the docs or submit PRs to improve them please do so on `github <https://github.com/RunestoneInteractive/runestoneinteractive.github.io/issues>`_
2424

@@ -88,9 +88,8 @@ You will now have a build folder with a file index.html in it, along with some d
8888

8989
Now from your browser you can open up ``http://localhost:8000/index.html`` You should see the table of contents for a sample page like this:
9090

91-
.. raw:: html
92-
93-
<img src="images/runeCompo-index.png" height="400" width="370">
91+
.. image:: images/runeCompo-index.png
92+
:width: 370
9493

9594

9695
If you edit ``_sources/index.html`` or ``_sources/overview.rst`` and then rebuild and serve again you will see your changes. The best documentation is probably the overview.rst file itself, as it demonstrates how to use all of the common components and shows most of their options.
@@ -178,7 +177,7 @@ If you have an error relating to PhantomJS/a driver in the output, you probably
178177

179178
* Write the appropriate directive example(s) inside the ``index.rst`` file (which will be created as a result of ``runestone init``)
180179

181-
* Edit the Python file you created as appropriate (see documentation for the Python ``unittest`` module `here <https://docs.python.org/2/library/unittest.html>`_.)
180+
* Edit the Python file you created as appropriate (see documentation for the Python ``unittest`` module `In the Python docs <https://docs.python.org/2/library/unittest.html>`_.)
182181

183182

184183
Notes for more Advanced Users
@@ -216,4 +215,4 @@ If you use Runestone in your Research or write about it, please reference ``http
216215
publisher = {ACM},
217216
address = {New York, NY, USA},
218217
keywords = {cs1, ebook, sphinx},
219-
}
218+
}

0 commit comments

Comments
 (0)