Adding user documentation

1. Navigate to your user folder <server_root>/users/<username>

2. Create a folder for the new documentation that you want to add (<documentation_name>).

For example, on Linux, you can use the following command to create this folder.

mkdir -p <server_root>/users/<username>/<documentation_name>

1. Copy the build folder that has been generated from your Sphinx project into the project folder you created in the previous step e.g. <server_root>/users/<username>/<documentation_name>/build

2. Tell the documentation server that you have added a new documentation directory:

1. Search for the documentationList html code block.

2. Append the following line to the documentationList block:

<li><a href="./documentation_name/build/index.html">documentation_name</a></li>

as shown by the highlighted block of text below:

<div class="container" style="margin-left:0px">
  <ul id="documentationList">
  <!-- TODO. Append a new item to the list -->
  <!-- Example list item
  <li><a href="./template-documentation/docs/build/index.html">template-documentation</a></li>
  -->
  <li><a href="./documentation_name/build/index.html">your documentation name</a></li>
  </ul>
</div>

1. Replace documentation_name in the line you just appended with the name of the folder you created in Step 2.

2. Replace your documentation name in the line you just appended with the name of your documentation.

3. Save and exit the file.