EditFrontMatter
Current Release: 0.0.1
Github Project Page
PyPi Project Page
Contents:
Full Features List
EditFrontMatter package
Edit Front Matter Module
Class: EditFrontMatter
__init__
add_JinjaFilter
del_JinjaFilter
dumpFileData
dumpFrontMatter
has_source_data
has_source_yaml
readFile
run
set_yaml_delim
writeFile
Class: EditFrontMatter_Exception
__init__
Example Programs
EditFrontMatter: Example 1
EditFrontMatter: Example 1 Readme
Running the program:
Basic Front Matter Editing Example
EditFrontMatter: Example 2
EditFrontMatter: Example 2 Readme
Running the program:
Advanced, Multi-Pass, Front Matter Editing Example
EditFrontMatter: Example 3
EditFrontMatter: Example 3 Readme
Program flow:
Constraints:
Running the program:
Example Input / Output
Threaded, Directory Walking Example
FAQ
Are these answers actually frequently asked?
Why is this project so heavily / distractingly / etc. documented?
Why did you write this module?
Where is the test suite!?
Contributing
EditFrontMatter Contributing Guidelines:
Changelog
Code License
About Theme
RTD Theme Developer Notes
Layout:
Sphinx Notes:
References:
Building:
Live update dev server
Fixes
Sphinx RTD Theme Notes:
References:
GitHub ‘Fork on GitHub’ Banner:
Site index on sidebar
Remove the word “module” from the end of sidebar code elements
Theme Style guide
References (for later documentation)
Docstrings (python)
Things to Document
Rules:
Generating class methods for use the sidebar toc and respective individual files
Before adding autosummary functionality
Generate method files
maintenance:
Include mardown document in reST
Boilerplate features
configurables
replacement text restrictions in the docstring for config.py
Pre publishing checklist
Packaging / PyPi Notes:
References:
pypy packaging steps
pip install module locally for development
Prepare the package files
Install distribution dependiencies
build distribution artifacts
upload to pypi
Sphinx config.py
Sphinx RTD boilerplate Readme
Running, Building and Testing
Running example apps
Building documentation
Testing documentation examples via
doctest
Author's Homepage
Overview: Source Code Function Index
Overview: Source Code Index
EditFrontMatter
Docs
»
Changelog
Edit on GitHub
Next
Previous
Changelog
¶
0.0
.
1
:
Initial
Version
