Building Docs and Make Html Files
Review Request #7191 — Created April 12, 2015 and discarded
Writing a document for how to builing docs and make html files.
Because there is no document to describe how to build a document, so this guide will show you how to build docs and transfer them into html files.It'll tell you how to make a docs and if you'd like to make it more beautiful,you can add some styles with Sphnix.
After that, you need to install Subversion so that you can transfer these into html files.
Click the html file, it can be shown in a proper format.
| Description | From | Last Updated |
|---|---|---|
|
Please make sure to wrap all lines at 79 characters. |
 brennie
|
|
|
You need to use the :file: prefix for any filenames/directories you're referencing. Also, single backticks aren't used for literals. |
 chipx86
|
|
|
You can just pip install this. |
chipx86
|
|
|
Typo here. |
chipx86
|
|
|
Make sure all trailing whitespace is removed from the file. |
chipx86
|
|
|
There's a typo here. |
chipx86
|
|
|
Make sure all sections are in Title Case. |
chipx86
|
|
|
This shouldn't have been changed. |
chipx86
|
|
|
This line (and all below) should be wrapped at 79 columns. |
 david
|
|
|
Typo (Sphnix -> Sphinx) |
david
|
|
|
Please revert this change. |
david
|
-
A few other notes:
- Make sure you add your review requests to the "students" group.
- You have "bug" in the bugs list, which isn't a bug number.
- Be sure to follow this guide for creating a suitable Description of your change: https://www.reviewboard.org/docs/codebase/dev/writing-good-descriptions/
CH
- Change Summary:
-
Change some code style and change the directory of it.
- Description:
-
~ The document tries to fixed the bug 3703.
~ The main idea: This guide will show you how to build docs and transfer them into html files. ~ The directory of it: ~ Building Docs and Make HTML Files ~ Build Docs ~ Writing a document for how to builing docs and make html files.
~ Because there is no document to describe how to build a document, so this guide will show you how to build docs and transfer them into html files. ~ ~ It'll tell you how to make a docs and if you'd like to make it more beautiful,you can add some styles with Sphnix.
~ After that, you need to install Subversion so that you can transfer these into html files. - Add Some Style - Make Html Files - Install Subversion - Install Sphnix - Transfer docs into html - Testing Done:
-
~ The links are OK~
~ Click the html file, it can be shown in a proper format.
- Bugs:
-
Tool: Pyflakes Ignored Files: docs/codebase/building-docs.rst docs/codebase/getting-started.rst Tool: PEP8 Style Checker Ignored Files: docs/codebase/building-docs.rst docs/codebase/getting-started.rst
CH
- Change Summary:
-
Change some code style and the order of directory.
- Commit:
-
ddd0c70d396265b16bb0204f8e8ca347f873fd9760909f2ea69fc117b61513c5f715a4e2489f7af2
-
Tool: Pyflakes Ignored Files: docs/codebase/building-docs.rst docs/codebase/getting-started.rst Tool: PEP8 Style Checker Ignored Files: docs/codebase/building-docs.rst docs/codebase/getting-started.rst
Tool: PEP8 Style Checker Ignored Files: docs/codebase/building-docs.rst docs/codebase/getting-started.rst Tool: Pyflakes Ignored Files: docs/codebase/building-docs.rst docs/codebase/getting-started.rst