Building Docs and Make Html Files

Review Request #7191 — Created April 12, 2015 and discarded

chenfeng
Review Board
master
3703
students

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.

  • 5
  • 0
  • 6
  • 0
  • 11
Description From Last Updated
Please make sure to wrap all lines at 79 characters. brennie brennie
This shouldn't have been changed. chipx86 chipx86
This line (and all below) should be wrapped at 79 columns. david david
Typo (Sphnix -> Sphinx) david david
Please revert this change. david david
  1. 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
    
    
  2. 
      
chipx86
  1. 
      
  2. docs/codebase/building-docs.rst (Diff revision 1)
     
     

    You need to use the :file: prefix for any filenames/directories you're referencing.

    Also, single backticks aren't used for literals.

  3. docs/codebase/building-docs.rst (Diff revision 1)
     
     
     
     
     
     
     
     
     
     
     
     
     
     

    You can just pip install this.

  4. docs/codebase/building-docs.rst (Diff revision 1)
     
     

    Typo here.

  5. docs/codebase/building-docs.rst (Diff revision 1)
     
     

    Make sure all trailing whitespace is removed from the file.

  6. docs/codebase/building-docs.rst (Diff revision 1)
     
     

    There's a typo here.

  7. docs/codebase/building-docs.rst (Diff revision 1)
     
     

    Make sure all sections are in Title Case.

  8. docs/codebase/getting-started.rst (Diff revision 1)
     
     

    This shouldn't have been changed.

    1. Does it means that I needn't to change the "getting-started" file?

  9. 
      
chipx86
  1. A few other notes:

    1. Make sure you add your review requests to the "students" group.
    2. You have "bug" in the bugs list, which isn't a bug number.
    3. Be sure to follow this guide for creating a suitable Description of your change: https://www.reviewboard.org/docs/codebase/dev/writing-good-descriptions/
  2. 
      
brennie
  1. 
      
  2. docs/codebase/building-docs.rst (Diff revision 1)
     
     

    Please make sure to wrap all lines at 79 characters.

    1. Please do not mark issues as fixed when they have not been addressed.

      Review Bot may not complain about the line length of .rst files, but we enforce the same line lengths for .rst as PEP8 does for Python.

  3. 
      
  1. 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
    
    
  2. 
      
  1. 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
    
    
  2. 
      
david
  1. 
      
  2. docs/codebase/building-docs.rst (Diff revision 3)
     
     

    This line (and all below) should be wrapped at 79 columns.

  3. docs/codebase/building-docs.rst (Diff revision 3)
     
     

    Typo (Sphnix -> Sphinx)

  4. docs/codebase/getting-started.rst (Diff revision 3)
     
     

    Please revert this change.

  5. 
      
david
Review request changed

Status: Discarded

Loading...