| Ales Komarek | 7b7636e | 2015-11-27 15:31:43 +0100 | [diff] [blame] | 1 | |
| 2 | ====== |
| 3 | Sphinx |
| 4 | ====== |
| 5 | |
| 6 | Sphinx is a tool that makes it easy to create intelligent and beautiful documentation, written by Georg Brandl and licensed under the BSD license. It was originally created for the new Python documentation, and it has excellent facilities for the documentation of Python projects, but C/C++ is already supported as well, and it is planned to add special support for other languages as well. |
| 7 | |
| 8 | Sample pillars |
| 9 | ============== |
| 10 | |
| 11 | Simple documentation with local source |
| 12 | |
| 13 | .. code-block:: yaml |
| 14 | |
| 15 | sphinx: |
| 16 | server: |
| 17 | enabled: true |
| 18 | doc: |
| 19 | board: |
| 20 | builder: 'html' |
| 21 | source: |
| 22 | engine: local |
| 23 | path: '/path/to/sphinx/documentation' |
| 24 | |
| 25 | Simple documentation with Git source |
| 26 | |
| 27 | .. code-block:: yaml |
| 28 | |
| 29 | sphinx: |
| 30 | server: |
| 31 | enabled: true |
| 32 | doc: |
| 33 | board: |
| 34 | builder: 'html' |
| 35 | source: |
| 36 | engine: git |
| 37 | address: 'git@repo1.domain.com/repo.git' |
| 38 | revision: master |
| 39 | |
| 40 | Simple documentation with reclass source |
| 41 | |
| 42 | .. code-block:: yaml |
| 43 | |
| 44 | sphinx: |
| 45 | server: |
| 46 | enabled: true |
| 47 | doc: |
| 48 | board: |
| 49 | builder: 'html' |
| 50 | source: |
| 51 | engine: reclass |
| 52 | |
| 53 | |
| 54 | Read more |
| 55 | ========= |
| 56 | |
| 57 | * http://sphinx-doc.org/tutorial.html |
| Filip Pytloun | 62bce8a | 2017-02-02 13:02:03 +0100 | [diff] [blame^] | 58 | |
| 59 | Documentation and Bugs |
| 60 | ====================== |
| 61 | |
| 62 | To learn how to install and update salt-formulas, consult the documentation |
| 63 | available online at: |
| 64 | |
| 65 | http://salt-formulas.readthedocs.io/ |
| 66 | |
| 67 | In the unfortunate event that bugs are discovered, they should be reported to |
| 68 | the appropriate issue tracker. Use Github issue tracker for specific salt |
| 69 | formula: |
| 70 | |
| 71 | https://github.com/salt-formulas/salt-formula-sphinx/issues |
| 72 | |
| 73 | For feature requests, bug reports or blueprints affecting entire ecosystem, |
| 74 | use Launchpad salt-formulas project: |
| 75 | |
| 76 | https://launchpad.net/salt-formulas |
| 77 | |
| 78 | You can also join salt-formulas-users team and subscribe to mailing list: |
| 79 | |
| 80 | https://launchpad.net/~salt-formulas-users |
| 81 | |
| 82 | Developers wishing to work on the salt-formulas projects should always base |
| 83 | their work on master branch and submit pull request against specific formula. |
| 84 | |
| 85 | https://github.com/salt-formulas/salt-formula-sphinx |
| 86 | |
| 87 | Any questions or feedback is always welcome so feel free to join our IRC |
| 88 | channel: |
| 89 | |
| 90 | #salt-formulas @ irc.freenode.net |