Chromium Code Reviews Chromium Code Reviews
Issue 345703002:
Adding development environment tutorial. (Closed)
Base URL: svn://svn.chromium.org/chrome/trunk/src| OLD | NEW |
|---|---|
| 1 nacl-docs-rst | 1 nacl-docs-rst |
| 2 ============= | 2 ============= |
| 3 | 3 |
| 4 Directory structure | 4 Directory structure |
| 5 ------------------- | 5 ------------------- |
| 6 | 6 |
| 7 This is a tree of .rst files that represent the source of the NaCl | 7 This is a tree of .rst files that represent the source of the NaCl |
| 8 documentation. Some of the files and directories here are special: | 8 documentation. Some of the files and directories here are special: |
| 9 | 9 |
| 10 * conf.py: Sphinx configuration file | 10 * conf.py: Sphinx configuration file |
| 11 * images/: Images are stored here. Note that this isn't necessary - Sphinx | 11 * images/: Images are stored here. Note that this isn't necessary - Sphinx |
| 12 doesn't mind about interspersing images in .rst directories. | 12 doesn't mind about interspersing images in .rst directories. |
| 13 * _sphinxext/: Code of the Sphinx extension we use to generate HTML from .rst | 13 * _sphinxext/: Code of the Sphinx extension we use to generate HTML from .rst |
| 14 * _static/: Static files, like CSS, for the documentation. This should be seen | 14 * _static/: Static files, like CSS, for the documentation. This should be seen |
| 15 as part of the infrastructure - the real CSS comes from the real doc | 15 as part of the infrastructure - the real CSS comes from the real doc |
| 16 publishing server. | 16 publishing server. |
| 17 * doxygen/: Contains scripts for building doxygen docs. | 17 * doxygen/: Contains scripts for building doxygen docs. |
| 18 * Makefile & README | 18 * Makefile & README |
| 19 | 19 |
| 20 All output is written to native_client_sdk/doc_generated/... | 20 All output is written to native_client_sdk/doc_generated/... |
| 21 | 21 |
| 22 How to build | 22 How to build |
| 23 ------------ | 23 ------------ |
| 24 | 24 |
| 25 To build the docs you will needs sphinx installed (and sphinx-build in your | 25 To build the docs you will need these debian/ubuntu packages: |
| 26 path). On debian/ubuntu this command is part of the ``python-sphinx`` package. | 26 ``python-sphinx`` |
| 27 ``python-beautifulsoup`` | |
|
Sam Clegg
2014/06/19 01:09:52
Use rst list syntax like above?
bradn
2014/06/19 17:22:55
Done.
| |
| 27 | 28 |
| 28 There are two primary make targets: ``chromesite`` and ``chromesite_rst``. The | 29 There are two primary make targets: ``chromesite`` and ``chromesite_rst``. The |
| 29 ``chromesite`` target will build all documentation, including the doxygen docs. | 30 ``chromesite`` target will build all documentation, including the doxygen docs. |
| 30 This usually takes about a minute. To build this config, run:: | 31 This usually takes about a minute. To build this config, run:: |
| 31 | 32 |
| 32 make | 33 make |
| 33 | 34 |
| 34 The ``chromesite_rst`` target will only build the ReST docs. This is usually | 35 The ``chromesite_rst`` target will only build the ReST docs. This is usually |
| 35 much faster. The default target is ``chromesite``. To build this config, run:: | 36 much faster. The default target is ``chromesite``. To build this config, run:: |
| 36 | 37 |
| (...skipping 18 matching lines...) Expand all Loading... | |
| 55 Checking outgoing links for integrity | 56 Checking outgoing links for integrity |
| 56 ------------------------------------- | 57 ------------------------------------- |
| 57 | 58 |
| 58 We use the Sphinx-provided link checker (configured in conf.py and with some | 59 We use the Sphinx-provided link checker (configured in conf.py and with some |
| 59 monkey-patching in the extension) to check the outgoing links from the | 60 monkey-patching in the extension) to check the outgoing links from the |
| 60 documentation. To run the link checker:: | 61 documentation. To run the link checker:: |
| 61 | 62 |
| 62 make linkcheck | 63 make linkcheck |
| 63 | 64 |
| 64 And look for "broken" in the output file. | 65 And look for "broken" in the output file. |
| OLD | NEW |
