diff options
| author |   John DeNisco <jdenisco@cisco.com> | 2018-08-13 17:00:06 -0400 |
|---|---|---|
| committer | John DeNisco <jdenisco@cisco.com> | 2018-08-13 17:00:22 -0400 |
| commit | 758dc46072032b7145a556804a29e87baa602958 (patch) | |
| tree | 9807426a9af2c21ebde9b61cb6771cec14a65ae9 /docs/gettingstarted/writingdocs/readthedocs.rst | |
| parent | 34eb5d423d8d5851d0e901114d359c91acf05c4e (diff) | |
DOCS: Cleanup Getting Started
Change-Id: I4766773779f8d5c30a24bfed48090d7305c80ec5
Signed-off-by: John DeNisco <jdenisco@cisco.com>
Diffstat (limited to 'docs/gettingstarted/writingdocs/readthedocs.rst')
| -rw-r--r-- | docs/gettingstarted/writingdocs/readthedocs.rst | 130 |
1 files changed, 0 insertions, 130 deletions
diff --git a/docs/gettingstarted/writingdocs/readthedocs.rst b/docs/gettingstarted/writingdocs/readthedocs.rst deleted file mode 100644 index f97b8d918b6..00000000000 --- a/docs/gettingstarted/writingdocs/readthedocs.rst +++ /dev/null @@ -1,130 +0,0 @@ -.. _readthedocs: - -******************* -Using Read the Docs -******************* - -`Read the Docs <https://readthedocs.org/>`_ is a website that "simplifies software documentation by automating building, versioning, and hosting of your docs for you". Essentially, it accesses your Github repo to generate the **index.html** file, and then displays it on its own *Read the Docs* webpage so others can view your documentation. - -Create an account on *Read the Docs* if you haven't already. - -Go to your `dashboard <https://readthedocs.org/dashboard/>`_ , and click on "Import a Project". - -.. figure:: /_images/importReadDocs.png - :scale: 35% - :align: left - - This will bring you to a page where you can choose to import a repo from your Github account (only if you've linked your Github account to your Read the Docs account), or to import a repo manually. In this example, we'll do it manually. Click "Import Manually". - -| -| -| -| -| -| -| - - - -This will bring you to a page that asks for your repo details. Set "Name" to your forked repo name, or whatever you want. Set "Repository URL" to the URL of your forked repo (https://github.com/YOURUSERNAME/vpp-docs). "Repository type" should already be selected to "Git". Then click "Next". - - -.. figure:: /_images/importRTDManually.png - :scale: 35% - :align: left - -| -| -| -| -| -| -| -| -| -| -| -| -| -| -| -| -| -| -| -| -| -| -| - - -This will bring you to a project page of your repo on Read the Docs. You can confirm it's the correct repo by checking on the right side of the page the Repository URL. - -Then click on "Build Version". - -.. figure:: /_images/buildVerRTD.png - :scale: 35% - :align: left - -| -| -| -| -| -| -| -| -| -| -| -| -| -| -| -| -| -| -| -| -| -| -| - -Which takes you to another page showing your recent builds. - -Then click on "Build Version:". This should "Trigger" a build. After about a minute or so you can refresh the page and see that your build "Passed". - - -.. figure:: /_images/passedBuild.png - :scale: 35% - :align: left - - -| -| -| -| -| -| -| -| -| -| -| -| -| -| -| -| -| -| -| -| -| - - -Now on your builds page from the previous image, you can click "View Docs" at the top-right, which will take you a *readthedocs.io* page of your generated build! - -.. figure:: /_images/rtdWebpage.png - :scale: 30% - :align: left |