Advertisement
gsavix

memo_sphinx_p10

Jan 17th, 2013
305
0
Never
Not a member of Pastebin yet? Sign Up, it unlocks many cool features!
text 3.37 KB | None | 0 0
  1. C:\Downloads>mkdir boletim
  2.  
  3. C:\Downloads>cd boletim
  4.  
  5. C:\Downloads\boletim>sphinx-quickstart
  6. Welcome to the Sphinx 1.1.3 quickstart utility.
  7.  
  8. Please enter values for the following settings (just press Enter to
  9. accept a default value, if one is given in brackets).
  10.  
  11. Enter the root path for documentation.
  12. > Root path for the documentation [.]:
  13.  
  14. You have two options for placing the build directory for Sphinx output.
  15. Either, you use a directory "_build" within the root path, or you separate
  16. "source" and "build" directories within the root path.
  17. > Separate source and build directories (y/N) [n]:
  18.  
  19. Inside the root directory, two more directories will be created; "_templates"
  20. for custom HTML templates and "_static" for custom stylesheets and other static
  21. files. You can enter another prefix (such as ".") to replace the underscore.
  22. > Name prefix for templates and static dir [_]:
  23.  
  24. The project name will occur in several places in the built documentation.
  25. > Project name: boletim nuto jan 2013
  26. > Author name(s): biblioteca municipal nuto santana
  27.  
  28. Sphinx has the notion of a "version" and a "release" for the
  29. software. Each version can have multiple releases. For example, for
  30. Python the version is something like 2.5 or 3.0, while the release is
  31. something like 2.5.1 or 3.0a1. If you don't need this dual structure,
  32. just set both to the same value.
  33. > Project version: 2013.1
  34. > Project release [2013.1]: 1
  35.  
  36. The file name suffix for source files. Commonly, this is either ".txt"
  37. or ".rst". Only files with this suffix are considered documents.
  38. > Source file suffix [.rst]:
  39.  
  40. One document is special in that it is considered the top node of the
  41. "contents tree", that is, it is the root of the hierarchical structure
  42. of the documents. Normally, this is "index", but if your "index"
  43. document is a custom template, you can also set this to another filename.
  44. > Name of your master document (without suffix) [index]:
  45.  
  46. Sphinx can also add configuration for epub output:
  47. > Do you want to use the epub builder (y/N) [n]:
  48.  
  49. Please indicate if you want to use one of the following Sphinx extensions:
  50. > autodoc: automatically insert docstrings from modules (y/N) [n]:
  51. > doctest: automatically test code snippets in doctest blocks (y/N) [n]:
  52. > intersphinx: link between Sphinx documentation of different projects (y/N) [n]
  53. :
  54. > todo: write "todo" entries that can be shown or hidden on build (y/N) [n]:
  55. > coverage: checks for documentation coverage (y/N) [n]:
  56. > pngmath: include math, rendered as PNG images (y/N) [n]:
  57. > mathjax: include math, rendered in the browser by MathJax (y/N) [n]:
  58. > ifconfig: conditional inclusion of content based on config values (y/N) [n]:
  59. > viewcode: include links to the source code of documented Python objects (y/N)
  60. [n]: y
  61.  
  62. A Makefile and a Windows command file can be generated for you so that you
  63. only have to run e.g. `make html' instead of invoking sphinx-build
  64. directly.
  65. > Create Makefile? (Y/n) [y]:
  66. > Create Windows command file? (Y/n) [y]:
  67.  
  68. Creating file .\conf.py.
  69. Creating file .\index.rst.
  70. Creating file .\Makefile.
  71. Creating file .\make.bat.
  72.  
  73. Finished: An initial directory structure has been created.
  74.  
  75. You should now populate your master file .\index.rst and create other documentat
  76. ion
  77. source files. Use the Makefile to build the docs, like so:
  78. make builder
  79. where "builder" is one of the supported builders, e.g. html, latex or linkcheck.
Advertisement
Add Comment
Please, Sign In to add comment
Advertisement