| 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 * _build/: Build artifacts (not checked into source control). | 17 * _build/: Build artifacts (not checked into source control). |
| 18 * Makefile & README | 18 * Makefile & README |
| 19 | 19 |
| 20 How to build | 20 How to build |
| 21 ------------ | 21 ------------ |
| 22 | 22 |
| 23 To build the docs you will needs sphinx installed (and sphinx-build in your | 23 To build the docs you will needs sphinx installed (and sphinx-build in your |
| 24 path). On debian/ubuntu this command is part of the ``python-sphinx`` package. | 24 path). On debian/ubuntu this command is part of the ``python-sphinx`` package. |
| 25 | 25 |
| 26 There are many different output formats that can be generated using the targets | 26 There are many different output formats that can be generated using the targets |
| 27 in the included Makefile. The three most commonly used ones are ``devsite``, | 27 in the included Makefile. The three most commonly used ones are ``devsite``, |
| 28 ``devsite-prod`` and ``devsite-staging``. | 28 ``devsite-prod`` and ``devsite-staging``. |
| 29 | 29 |
| 30 The ``devsite`` configuration is for generating docs for local viewing and is | 30 The ``devsite`` configuration is for generating docs for local viewing and is |
| 31 also the default make target. To build this config simply run:: | 31 also the default make target. To build this config simply run:: |
| 32 | 32 |
| 33 make | 33 make |
| 34 | 34 |
| (...skipping 41 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 76 Checking outgoing links for integrity | 76 Checking outgoing links for integrity |
| 77 ------------------------------------- | 77 ------------------------------------- |
| 78 | 78 |
| 79 We use the Sphinx-provided link checker (configured in conf.py and with some | 79 We use the Sphinx-provided link checker (configured in conf.py and with some |
| 80 monkey-patching in the extension) to check the outgoing links from the | 80 monkey-patching in the extension) to check the outgoing links from the |
| 81 documentation. To run the link checker:: | 81 documentation. To run the link checker:: |
| 82 | 82 |
| 83 make linkcheck | 83 make linkcheck |
| 84 | 84 |
| 85 And look for "broken" in the output file. | 85 And look for "broken" in the output file. |
| OLD | NEW |
|---|
Chromium Code Reviews
Issue 140993006:
[NaCl SDK Docs] Check in the generated NaCl SDK Documentation. (Closed)
Base URL: svn://svn.chromium.org/chrome/trunk/src