Create Read the Docs Document

By Jack Henderson

In this tutorial, you’ll create a simple Read the Docs document and post it to the web.

Prerequisites

Before you start, you will need a ReadTheDocs.org account: Read the Docs .

Step 1: Create Document

Write the document in Word using text and pictures.

../_images/11.png

After creating your document. Add “.. image:: create-an-event-as-draft/_static/1.png” line above each picture. This is the relative file name that you will save the picture as. Increment the file name number for each consecutive picture.

../_images/21.png

Create a folder for the new document:

../_images/31.png

Create a folder under the newly create project folder named “_static”.

../_images/41.png

Create a flat file (text file) with the extension .rst. Use a text editor such as PyCharm.

../_images/5.png ../_images/6.png

Name them (with incrementing number to be unique): e.g. D:devReposfasterpaceDocsfasterpacetutorialscreate-an-event-as-draft_static1.png Now that you have all the pictures saved and their names added just above each picture in the word document, you can copy that text (all of it) into the .rst file: Edit the index file (D:devReposfasterpaceDocsfasterpacetutorialsindex.rst) and add the new project:

../_images/7.png

Build the project and verify it for accuracy. Delete the _build folder (we don’t need it anymore).

../_images/8.png

Launch Github desktop and add the new files to project.

../_images/9.png

Request the Pull:

../_images/10.png ../_images/111.png ../_images/12.png

Now build it in “ReadTheDoc.org”: https://readthedocs.org/projects/fasterpace-docs/ Click Build

../_images/13.png

Click Build Wait for long time ;) Navigate to docs: http://fasterpace-docs.readthedocs.org/

../_images/14.png

Done!