Doc Standard
0.0
Site
1. Introduction
2. Sphinx Doc
2.1. Documentation workflow
2.2. Initialize documentation
2.2.1. New article
2.2.2. New book
2.3. Documentation output formats
2.3.1. Article format
2.3.2. Book format
2.4. Update documentation template structure
2.5. Document administration
2.5.1. Automodule files
2.5.2. Chapters
2.5.2.1. Adding a chapter
2.5.3. View processed documents
2.5.4. Command handlers for backends
2.6. Structural specification
2.6.1. README chapters
2.6.2. README snippets
2.7. How to properly move chapter files and sections
2.7.1. Rename chapter file in same document directory
2.7.2. Move chapter file to other document directory
2.7.3. How to move a section from one chapter file to another chapter file
2.7.4. Traceability of section modifications
2.8. ReST section overlines
3. sda chapter new is Faulty
3.1. From Gibberish to Brilliant Clarity
3.1.1. BNF Is a Tool That Needs To Be Mastered As Such
4. Figures
4.1. Figures with numbers
4.1.1. Directive
figure
4.1.2. Directive
table
4.1.3. Directive
code-block
4.1.4. Directive
uml
4.1.5. Directives
graphviz
,
dot
4.1.6. Directive
figctr
4.2. See also
4.3. Check README for figure requirements
4.4. Templating with automatic labels (NO!)
5. Citations
6. Glossary
6.1. As for the style of glossary entries
6.2. Multiple
glossary
directives
6.2.1. Order of abbreviations and glossary
6.3. Combinations of glossary and abbreviation generation
6.3.1. Object diagrams
6.3.2. Class diagram
6.3.3. Activity diagrams
6.3.4. State diagram
7. UML annotations - line_diversion
7.1. Emacs support
7.2. Annotation tags and markers
7.2.1. Comment start regular expression
7.2.2. Line diversion types
7.3. Practical annotation
7.4. Activity Diagrams (extracted)
7.4.1. Extract UML diagrams
7.4.2. Process Matching Line
7.5. Class Diagram (extracted)
7.6. Command/Module Documentation
7.6.1. Options
7.6.2. Module
7.6.3. Automatic Exports
7.6.4. Explicit Exports
7.6.5. Details
7.6.5.1. Prefix Match
7.6.5.2. Condition Match
7.6.5.3. Action Match
8. Relevance of Documentation
8.1. Introduction
8.2. Source and documentation management
8.3. Minimum Distance to Source Code
8.4. Inertia
8.5. Single Editor for Source and Documentation
8.6. Synchronization
8.6.1. qs-gen-sync.pl (.sync.rc)
8.6.2. diff3
8.7. Battling Human Inertia
8.7.1. Integrated Development Environment
9. Version Control System
9.1. Cherry-Picking
9.1.1. Mercurial
9.1.1.1. Adding additional changes to the patch
9.1.2. Git
10. VCS - Mercurial
10.1. Repository Manipulation
10.1.1. convert
10.1.2. Remove unwanted branches, clone –rev
11. VCS - Git
11.1. GUI
11.2. github fork
11.2.1. Syncing the github fork with upstream
11.2.2. Cloning a github fork
11.2.3. Adding an upstream repository
11.3. Quickstart
11.4. Tricks
11.4.1. Find the first commit of a branch
11.4.2. Delete commits
11.4.3. How to modify existing, unpushed commits
11.5. Create branches
11.6. Patches
11.7. Github Forking
11.7.1. Step 3: Configure remotes
11.8. Resolving merge conflicts with git and kdiff3
12. Unified Modeling Language
12.1. UML Introduction
12.1.1. Getting Started with UML Diagrams
12.1.2. Quick Reference Guides
12.1.3. Reference Guides and Tutorials
12.1.4. UML Tools
12.1.5. UML GUI Tools
12.1.6. Tools for Translating Declarative Specs to Diagrams
12.2. UML Diagrams
12.2.1. Use Case Diagram
12.2.2. Class Diagram
12.2.2.1. Associations between classes
12.2.2.2. Class Diagram Examples
12.2.3. Activity Diagram
12.2.3.1. Activity Diagram Examples
12.2.4. State Machine Diagram
12.2.5. Sequence Diagram
12.2.5.1. Sequence Diagram Examples
12.3. PlantUML
12.3.1. PlantUML Usage
12.3.2. PlantUML Installation
12.3.3. PlantUML Emacs Mode
12.3.3.1. Enable the Major Mode
12.3.3.2. Emacs Mode Usage
12.3.3.3. Default Key Bindings
12.3.3.4. UMLX
12.3.3.5. Emacs Mode Installation
12.4. yUML
12.4.1. Installation
12.5. Other UML Tools
12.5.1. Declarative
12.5.2. GUI with UML standard support
12.5.3. Generic Diagrams
12.5.4. Auto generators
12.6. Summary
12.6.1. Object diagram with dot(1)
13. Tools
13.1. Document Generation Issues
13.2. Activity Diagrams for
rst2md.sh
13.3. Activity Diagrams for
sphinx-doc-locate.sh
13.4. Activity Diagrams for
bin/inst.sh
14. Sphinx Documentation Generator
14.1. ReStructuredText Tips and Issues
14.1.1. Spaces at the beginning of formatted text
14.1.2. Invisible substitutions (space/blank)
14.1.3. Representing space characters
14.1.4. LaTeX Unicode declarations
14.2. Slides
14.2.1. HTML theme
14.2.2. Standalone target
14.2.3. Docutils only
14.3. Sphinx Themes
14.4. Graphviz Dot
14.4.1. Graphviz dot(1) Information
14.5. Sphinx Mercurial
14.6. ReStructuredText and Sphinx bridge to Doxygen
15. Diagram generators
16. Emacs vs. Vi vs. Eclipse vs. anyIDE
16.1. How to install latest stable Emacs in Ubuntu
16.1.1. Setup for emacsen-common
16.1.2. Obsolete packages
16.1.3. Modify/repair packages
16.1.4. Activate packages
16.1.5. Optional packages
16.1.6. Integrate emacs into emacsen-common
16.2. Point, mark, region, kill ring
16.3. Undo
16.3.1. Standard Undo Function
16.3.2. Emacs Undo Function
16.3.3. Emacs Undo Tree
16.4. Abbreviations
16.5. Dynamic Abbreviation Expansion
16.6. Key Sequences
16.7. Extensions
16.8. Tips and Tricks
16.9. Useful packages
16.9.1. Table editing
16.10. Symbol tags
16.11. Directory/filename shortcuts
16.11.1. URL Link Generation
16.11.2. URL key bindings
16.11.3. Embedded link definition from separate link definition
17. Document Snippets
17.1. Document Snippet Definition
17.1.1. Item Prefix
17.1.2. Item Prefix Snippet Examples
17.1.3. Document Snippet Names
17.1.4. Document Snippet Flags
17.1.5. Document Snippet Examples
17.2. Snippet Tag Substitutions
17.3. Document Snippet References
17.3.1. Item Prefix Reference
17.3.2. Item Prefix Reference Examples
17.3.3. Reference Features
17.3.4. Reference Feature Examples
17.3.5. Reference Headers
17.3.6. Reference Examples
17.4. Replacement Facilities
17.4.1. Replacement Test
17.5. sphinx_doc_snip.py
17.5.1. Options
17.5.2. Description
17.5.2.1. Configuration Files
17.5.2.2. Replacements
17.5.3. Module
17.5.4. Automatic Exports
17.5.5. Explicit Exports
17.5.6. Details
18. Snippets
18.1. Templating
18.1.1. Emacs
18.1.1.1. Skeleton mode
19. High Contrast Colors
19.1. High Contrast Palette with 24 Colors
19.2. Thunderbird Tags
19.3. High Contrast Palette with alternative X11 colors
19.4. References
20. X11 Colors
20.1. X11 Colors - Web Colors
20.2. X11 Colors
20.3. X11 Colors - Gradients
20.4. X11 Colors - Grey Scale
21. Knowledge Organization
21.1. Trees
21.1.1. Definition of a Tree
21.1.2. Walking Around a Tree
21.1.2.1. Depth-First search
21.1.2.2. Breadth-First search
21.1.2.3. Illustrative Video
21.1.3. Books
21.1.4. Mindmaps
21.2. Generalization
21.2.1. Circular Graphs
21.2.2. Venn Diagrams
21.3. Conclusion
22. Scratch
22.1. Style Guide
22.2. Emacs
22.2.1. Symbol tags
22.3. Other Diagrams
22.4. Activity Diagrams
22.5. Emacs Buffers with Highlighting
22.6. Tastatur- und Spracheinstellung
22.7. Build statistics
23. Questions
24. rst-mode etags Support
24.1. Resources
24.2. etags Interface
24.2.1. TAGS File Structure
24.2.2. Sample TAGS File
24.3. diffmap
24.3.1. Options
24.3.2. Description
24.3.2.1. Line mapping, when source file hunk is completely removed
24.3.2.2. Line mapping, when target file hunk is completely removed
24.3.2.3. Line mapping, when source and target file hunk overlap
24.3.3. Module
24.3.4. Automatic Exports
24.3.5. Explicit Exports
24.3.6. Details
General Index
Python Module Index
Page
Index
A
|
C
|
D
|
E
|
F
|
H
|
I
|
J
|
L
|
M
|
O
|
P
|
R
|
S
|
X
A
a black blade runner
abbr
Abbreviation
abbrr
,
[1]
assemble() (line_diversion.LineParser method)
C
check_line_parse() (in module line_diversion)
clear() (diffmap.DiffMap method)
close_partition() (line_diversion.Diagram method)
(line_diversion.LineDiversion method)
D
Diagram (class in line_diversion)
DiagramActivity (class in line_diversion)
DiagramBehavior (class in line_diversion)
DiagramClass (class in line_diversion)
DiagramComponent (class in line_diversion)
DiagramDeployment (class in line_diversion)
DiagramInteraction (class in line_diversion)
DiagramMessageSequence (class in line_diversion)
DiagramObject (class in line_diversion)
DiagramStateMachine (class in line_diversion)
DiagramStructure (class in line_diversion)
DiagramTiming (class in line_diversion)
DiagramUseCase (class in line_diversion)
DiffMap (class in diffmap)
diffmap (module)
Document (class in sphinx_doc_snip)
Documentation (class in sphinx_doc_snip)
dump() (sphinx_doc_snip.Snippet method)
dump_snippets() (sphinx_doc_snip.Document method)
(sphinx_doc_snip.Documentation method)
E
EASE
Extensible Markup Language
F
f i r s t
finish() (line_diversion.LineDiversion method)
first
H
HTML
HTTP
HyperText Markup Language
I
IDE
init() (line_diversion.LineParser method)
J
Joint Photographic Experts Group
JPEG
L
line_diversion (module)
LineDiversion (class in line_diversion)
LineParser (class in line_diversion)
load() (sphinx_doc_snip.Document method)
lookup() (diffmap.DiffMap method)
M
map_snippets() (sphinx_doc_snip.Document method)
match() (line_diversion.LineParser method)
O
open_partition() (line_diversion.Diagram method)
(line_diversion.LineDiversion method)
P
parse() (diffmap.DiffMap method)
(sphinx_doc_snip.Document method)
parse_diff() (diffmap.DiffMap method)
PDF
PNG
Portable Network Graphics
prepare() (sphinx_doc_snip.Snippet method)
process_parts() (line_diversion.Diagram method)
R
ranges() (diffmap.DiffMap method)
register() (sphinx_doc_snip.Documentation method)
register_snippets_with() (sphinx_doc_snip.Document method)
reset() (sphinx_doc_snip.Snippet method)
resolve() (sphinx_doc_snip.Document method)
(sphinx_doc_snip.Documentation method)
(sphinx_doc_snip.Section method)
REST
RPC
rx (line_diversion.LineParser attribute)
S
SDL
Section (class in sphinx_doc_snip)
SGML
Snippet (class in sphinx_doc_snip)
Specification and Description Language
sphinx_doc_snip (module)
split() (line_diversion.LineParser method)
split_() (line_diversion.LineParser method)
SVG
X
XML