Documentation

Tip

Documentation on this site is written in ReStructuredText, or RST for short. Please check the RST Primer if you are not familiar with RST.

This page will guide you through writing great documentation for the UBports project that can be featured on this site.

Documentation guidelines

These rules govern how you should write your documentation to avoid problems with style, format, or linking. If you don’t follow these guidelines, we will not accept your document.

Title

All pages must have a document title that will be shown in the table of contents (left sidebar) and at the top of the page. This title is underlined with equals signs.

Titles should be sentence cased rather than Title Cased. For example:

Incorrect casing:
    Writing A Good Bug Report
Correct casing:
    Writing a good bug report
Correct casing when proper nouns are involved:
    Installing Ubuntu Touch on your phone

There isn’t a single definition of title casing that everyone follows, but sentence casing is easy. This helps keep capitalization in the table of contents consistent.

Table of contents

People can’t navigate to your new page if they can’t find it. Neither can Sphinx. That’s why you need to add new pages to Sphinx’s table of contents.

You can do this by adding the page to the index.rst file in the same directory that you created it. For example, if you create a file called “newpage.rst”, you would add the line marked with a chevron (>) in the nearest index:

.. toctree::
    :maxdepth: 1
    :name: example-toc

    oldpage
    anotheroldpage
>   newpage

The order matters. If you would like your page to appear in a certain place in the table of contents, place it there. In the previous example, newpage would be added to the end of this table of contents.

Warnings

Your edits must not introduce any warnings into the documentation build. If any warnings occur, the build will fail and your pull request will be marked with a red ‘X’. Please ensure that your RST is valid and correct before you create a pull request. This is done automatically (via sphinx-build crashing with your error) if you follow our build instructions below.

Contribution workflow

Note

You will need a GitHub account to complete these steps. If you do not have one, click here to begin the process of making an account.

Directly on GitHub

Read the Docs and GitHub make it fairly simple to contribute to this documentation. This section will show you the basic workflow to get started by editing an existing page on GitHub

  1. Find the page you would like to edit
  2. Click the “Edit on GitHub” link to the right of the title
  3. Make your changes to the document. Remember to write in ReStructuredText!
  4. Propose your changes as a Pull Request.

If there are any errors with your proposed changes, the documentation team will ask you to make some changes and resubmit. This is as simple as editing the file on GitHub from your fork of the repository.

Manually forking the repository

You can make more advanced edits to our documentation by forking ubports/docs.ubports.com on GitHub. If you’re not sure how to do this, check out the excellent GitHub guide on forking projects.

Building this documentation locally

If you’d like to build this documentation before sending a PR (which you should), follow these instructions on your local copy of your fork of the repository.

The documentation can be built by running ./build.sh in the root of this repository. The script will also create a virtual build environment in ~/ubportsdocsenv if none is present.

If all went well, you can enter the _build directory and open index.html to view the UBports documentation.

Current TODOs

This page lists the TODOs that have been included in this documentation. If you know how to fix one, please send us a PR to make it better!

To create a todo, add this markup to your page:

.. todo:

   My todo text