DOCSLIB.ORG

Sphinx Documentation Release 1.5.6

Total Page：16

File Type：pdf, Size：1020Kb

Download full-text PDF Read full-text
Sphinx Documentation Release 1.5.6 Sphinx Documentation Release 1.5.6 Georg Brandl Nov 13, 2017 Contents 1 Introduction 1 1.1 Conversion from other systems....................................1 1.2 Use with other systems........................................2 1.3 Prerequisites..............................................2 1.4 Usage..................................................2 2 First Steps with Sphinx 3 2.1 Install Sphinx..............................................3 2.2 Setting up the documentation sources................................3 2.3 Defining document structure.....................................4 2.4 Adding content.............................................5 2.5 Running the build...........................................5 2.6 Documenting objects..........................................5 2.7 Basic configuration...........................................6 2.8 Autodoc.................................................7 2.9 Intersphinx...............................................7 2.10 More topics to be covered.......................................8 3 Man Pages 9 3.1 Core Applications...........................................9 3.2 Additional Applications........................................ 15 4 reStructuredText Primer 19 4.1 Paragraphs............................................... 19 4.2 Inline markup.............................................. 19 4.3 Lists and Quote-like blocks...................................... 20 4.4 Source Code............................................... 21 4.5 Tables.................................................. 22 4.6 Hyperlinks............................................... 22 4.7 Sections................................................. 23 4.8 Explicit Markup............................................ 23 4.9 Directives................................................ 23 4.10 Images.................................................. 25 4.11 Footnotes................................................ 26 4.12 Citations................................................. 26 4.13 Substitutions.............................................. 27 4.14 Comments................................................ 27 i 4.15 Source encoding............................................ 27 4.16 Gotchas................................................. 27 5 Sphinx Markup Constructs 29 5.1 The TOC tree.............................................. 29 5.2 Paragraph-level markup........................................ 32 5.3 Table-of-contents markup....................................... 34 5.4 Glossary................................................. 34 5.5 Grammar production displays.................................... 35 5.6 Showing code examples........................................ 36 5.7 Inline markup.............................................. 40 5.8 Miscellaneous markup......................................... 46 6 Sphinx Domains 51 6.1 What is a Domain?........................................... 51 6.2 Basic Markup.............................................. 51 6.3 The Python Domain.......................................... 53 6.4 The C Domain............................................. 58 6.5 The C++ Domain............................................ 59 6.6 The Standard Domain......................................... 67 6.7 The JavaScript Domain........................................ 68 6.8 The reStructuredText domain..................................... 70 6.9 More domains............................................. 71 7 Available builders 73 7.1 Serialization builder details...................................... 79 8 The build configuration file 81 8.1 General configuration......................................... 82 8.2 Project information........................................... 86 8.3 Options for internationalization................................... 87 8.4 Options for HTML output....................................... 90 8.5 Options for Apple Help output.................................... 96 8.6 Options for epub output........................................ 98 8.7 Options for LaTeX output....................................... 101 8.8 Options for text output........................................ 107 8.9 Options for manual page output................................... 107 8.10 Options for Texinfo output...................................... 108 8.11 Options for QtHelp output...................................... 109 8.12 Options for the linkcheck builder.................................. 109 8.13 Options for the XML builder..................................... 110 8.14 Options for the C++ domain..................................... 110 9 Example of configuration file 113 10 Internationalization 121 10.1 Sphinx internationalization details.................................. 122 10.2 Translating with sphinx-intl...................................... 123 10.3 Using Transifex service for team translation............................ 124 10.4 Contributing to Sphinx reference translation............................ 126 11 HTML theming support 127 11.1 Using a theme.............................................. 127 11.2 Builtin themes............................................. 128 11.3 Creating themes............................................ 132 ii 11.4 Distribute your theme as a python package............................. 133 11.5 Third Party Themes.......................................... 134 12 Setuptools integration 135 12.1 Using setuptools integration..................................... 135 12.2 Options for setuptools integration.................................. 136 13 Templating 139 13.1 Do I need to use Sphinx’s templates to produce HTML?..................... 139 13.2 Jinja/Sphinx Templating Primer................................... 139 13.3 Working with the builtin templates................................. 140 14 LaTeX customization 145 14.1 Basic customization.......................................... 145 14.2 The LaTeX style file options...................................... 146 14.3 LaTeX macros and environments................................... 149 15 Markdown support 153 15.1 Configuration.............................................. 153 16 Sphinx Extensions 155 16.1 Builtin Sphinx extensions....................................... 155 16.2 Third-party extensions......................................... 190 17 Developing extensions for Sphinx 191 17.1 Discovery of builders by entry point................................. 191 17.2 Extension metadata.......................................... 192 17.3 APIs used for writing extensions................................... 192 18 Sphinx Web Support 221 18.1 Web Support Quick Start....................................... 221 18.2 The WebSupport Class......................................... 225 18.3 Search Adapters............................................ 226 18.4 Storage Backends............................................ 226 19 Sphinx FAQ 229 19.1 How do I.................................................. 229 19.2 Using Sphinx with............................................. 230 19.3 Epub info................................................ 231 19.4 Texinfo info............................................... 232 20 Glossary 235 21 Sphinx Developer’s Guide 237 21.1 Bug Reports and Feature Requests.................................. 238 21.2 Contributing to Sphinx........................................ 238 21.3 Coding Guide.............................................. 241 21.4 Deprecating a feature......................................... 242 21.5 Deprecation policy........................................... 242 21.6 Unit Testing............................................... 242 22 Changes in Sphinx 245 22.1 Release 1.7 (in development)..................................... 245 22.2 Release 1.6.6 (in development).................................... 247 22.3 Release 1.6.5 (released Oct 23, 2017)................................. 247 22.4 Release 1.6.4 (released Sep 26, 2017)................................. 248 iii 22.5 Release 1.6.3 (released Jul 02, 2017).................................. 249 22.6 Release 1.6.2 (released May 28, 2017)................................. 249 22.7 Release 1.6.1 (released May 16, 2017)................................. 250 22.8 Release 1.6 (unreleased)........................................ 255 22.9 Release 1.5.6 (released May 15, 2017)................................. 256 22.10 Release 1.5.5 (released Apr 03, 2017)................................. 256 22.11 Release 1.5.4 (released Apr 02, 2017)................................. 256 22.12 Release 1.5.3 (released Feb 26, 2017)................................. 257 22.13 Release 1.5.2 (released Jan 22, 2017)................................. 258 22.14 Release 1.5.1 (released Dec 13, 2016)................................. 259 22.15 Release 1.5 (released Dec 5, 2016)................................... 260 22.16 Release 1.4.9 (released Nov 23, 2016)................................. 266 22.17 Release 1.4.8 (released Oct 1, 2016).................................. 266 22.18 Release 1.4.7 (released Oct 1, 2016).................................. 266 22.19 Release 1.4.6 (released Aug 20, 2016)................................. 267 22.20 Release 1.4.5 (released Jul 13, 2016).................................. 268 22.21 Release 1.4.4 (released Jun 12, 2016)................................. 269 22.22 Release 1.4.3 (released Jun 5, 2016).................................. 269 22.23 Release 1.4.2 (released May 29, 2016)................................. 270 22.24 Release 1.4.1 (released
Load more

Recommended publications
  • Coala Documentation Release 0.4.1.Dev0
    coala Documentation Release 0.4.1.dev0 The coala Developers February 16, 2016 Home i ii CHAPTER 1 coala Installation This document contains information on how to install coala. Supported platforms are Linux and Windows. coala is known to work on OS X as well. coala is tested against CPython 3.3, 3.4 and 3.5. In order to run coala you need to install Python. It is recommended, that you install Python3 >= 3.3 from http://www.python.org. The easiest way to install coala is using pip (Pip Installs Packages). If you don’t already have pip, you can install it like described on https://pip.pypa.io/en/stable/installing.html. Note that pip is shipped with recent python versions by default. 1.1 System wide installation The simplest way to install coa ais to do it system-wide. But, This is generally discouraged in favor or using a virtualenv. To install the latest most stable version of coala system-wide, use: $ pip3 install coala To install the nightly build from our master branch, you can do: Note: For this and all future steps, some steps require root access (also known as administrative privileges in Win- dows). Unix based (Max, Linux) - This can be achieved by using sudo in front of the command sudo command_name instead of command_name Windows - The easiest way on windows is to start a command prompt as an administrator and start setup.py. $ pip3 install coala --pre 1.2 Installing inside a virtualenv Virtualenv is probably what you want to use during development, you’ll probably want to use it there, too.
    [Show full text]
  • Coala Documentation Release 0.7.0
    coala Documentation Release 0.7.0 The coala Developers June 22, 2016 Home 1 coala Installation 1 1.1 System wide installation.........................................1 1.2 Installing inside a virtualenv.......................................2 1.3 Installing coala from source.......................................2 1.4 Dependencies...............................................3 2 coala Tutorial 5 2.1 Prerequisites...............................................5 2.2 Get Some Code..............................................5 2.3 Let’s Start!................................................5 2.4 Sections..................................................6 2.5 Auto-applying results..........................................7 2.6 Setting Inheritance............................................8 2.7 Ignoring Issues..............................................8 2.8 Enabling/Disabling Sections.......................................9 2.9 Show bears’ information.........................................9 2.10 Continuing the Journey.......................................... 10 3 The .coafile Specification 11 3.1 Naming, Scope and Location...................................... 11 3.2 Setting Inheritance............................................ 11 4 Glob - Extended unix style pathname expansion 13 4.1 Syntax.................................................. 13 4.2 Examples................................................. 13 5 Exit Codes 17 6 External APIs 19 6.1 DBus................................................... 19 7 Git Hooks 21 7.1 Pre Commit
    [Show full text]
  • A Curated List of Awesome Python Frameworks, Libraries, Software and Resources 30/04/2018, 1016
    vinta/awesome-python: A curated list of awesome Python frameworks, libraries, software and resources 30/04/2018, 1016 vinta / awesome-python A curated list of awesome Python frameworks, libraries, software and resources https://awesome-python.com/ # awesome # python # collections # python-library # python-framework 1,241 commits 2 branches 0 releases 291 contributors Branch: master New pull request Create new file Upload files Find file Clone or download vinta Merge pull request #1063 from seth-stansberry/grammar … Latest commit 70cf6a4 10 hours ago .github update PR template again 2 years ago docs update mkdocs config 20 days ago .gitignore use MkDocs to generate a static website 3 years ago .travis.yml fix typo 2 years ago CONTRIBUTING.md fix typo 3 years ago LICENSE add LICENSE Fixes #328 3 years ago Makefile update mkdocs config 20 days ago README.md Update README.md Grammar 11 hours ago mkdocs.yml update mkdocs config 20 days ago sort.py fix sort.py 2 years ago README.md Awesome Python A curated list of awesome Python frameworks, libraries, software and resources. Inspired by awesome-php. Awesome Python Admin Panels Algorithms and Design Patterns Anti-spam Asset Management Audio Authentication Build Tools Built-in Classes Enhancement Caching ChatOps Tools CMS Code Analysis Command-line Tools Compatibility Computer Vision Concurrency and Parallelism https://github.com/vinta/awesome-python Page 1 of 28 vinta/awesome-python: A curated list of awesome Python frameworks, libraries, software and resources 30/04/2018, 1016 Configuration
    [Show full text]
  • Coala Documentation Release 0.5.2
    coala Documentation Release 0.5.2 The coala Developers June 17, 2016 Home 1 coala Installation 1 1.1 System wide installation.........................................1 1.2 Installing inside a virtualenv.......................................2 1.3 Installing coala from source.......................................2 1.4 Dependencies...............................................3 2 The .coafile Specification 5 2.1 Naming, Scope and Location......................................5 2.2 Setting Inheritance............................................5 3 Glob - Extended unix style pathname expansion7 3.1 Syntax..................................................7 3.2 Examples.................................................7 4 Exit Codes 11 5 External APIs 13 5.1 DBus................................................... 13 6 Git Hooks 15 6.1 Pre Commit Hooks............................................ 15 7 coala Tutorial 17 7.1 Prerequisites............................................... 17 7.2 Get Some Code.............................................. 17 7.3 Let’s Start!................................................ 17 7.4 Sections.................................................. 18 7.5 Auto-applying results.......................................... 19 7.6 Setting Inheritance............................................ 19 7.7 Ignoring Issues.............................................. 20 7.8 Enabling/Disabling Sections....................................... 21 7.9 Show bears’ information......................................... 21 7.10 Integrating
    [Show full text]
  • Lista.Txt Thu Jan 01 10:19:02 2015 1 0Ad-Data 2Ping 2Vcard 389
    lista.txt Thu Jan 01 10:19:02 2015 1 0ad-data 2ping 2vcard 389-console 3dchess 3depict 4digits 4g8 4store 6tunnel 7kaa-data 8086tiny 8086tiny-dev 9base 9menu 9wm a2jmidid a2ps a56 a7xpg a7xpg-data aa3d aajm aaphoto abacas abby abcde abcm2ps abcmidi abcmidi-yaps abe abe-data abgate abi-compliance-checker abicheck abinit abinit-doc abiword abiword-common abiword-dbg abiword-plugin-grammar abiword-plugin-mathview abntex abook abootimg abr2gbr abraca abs-guide abtransfers abuse abuse-lib abuse-sfx accerciser accessodf accountsservice acct ace-gperf ace-netsvcs ace-of-penguins acedb-other acedb-other-belvu acedb-other-dotter aces3 acetoneiso acfax lista.txt Thu Jan 01 10:19:02 2015 2 acgvision-agent acheck acheck-rules acheck-rules-fr achilles ack ack-grep acl acl2 acl2-books acl2-books-certs acl2-books-source acl2-doc acl2-emacs acl2-infix acl2-infix-source acl2-source aclock.app acm aconnectgui acorn-fdisk acoustid-fingerprinter acpi-support acpi-support-base acpid acpitool acpitool-dbg actionaz activemq activity-log-manager activiz.net-doc activiz.net-examples ada-reference-manual-2005 ada-reference-manual-2012 adabrowse adacgi1 adacontrol adanaxisgpl adanaxisgpl-data addresses-goodies-for-gnustep addresses.framework addressmanager.app addressview.framework adduser adept adjtimex adlint admesh adminer adns-tools adonthell-data adplay adplug-utils adun.app advancecomp advene advi advi-examples adzapper aegis aegis-doc aegis-tk aegis-web aegisub aegisub-l10n lista.txt Thu Jan 01 10:19:02 2015 3 aeolus aephea aes2501-wy aesfix aeskeyfind aeskulap
    [Show full text]