Skip to content

OdtParser allows to include odt files in sphinx-doc

License

Notifications You must be signed in to change notification settings

global-system/Sphinx-OdtParser

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Sphinx-OdtParser

OdtParser allows to include odt(libreoffice) files in sphinx-doc.

See pandoc for details of supported markup.

Installation

  1. Install pandoc.

    See: https://pandoc.org/

  2. Install sphinx-doc

    See: bin/initdev.cmd

  3. Copy src/sphinx_odtparser in a directory which is included in PYTHONPATH

Add OdtParser

Add following in the config.py:

from sphinx_odtparser.OdtParser import OdtParser
def setup(app):
    app.add_source_parser(OdtParser)
    app.add_source_suffix(".bodt","bodt")

see: testdoc/source/conf.py

Include odt files in build

  1. Save some file in the source directory.
  2. Create the build marker in the same directory

    It is the file with the same name and "bodt" extension

  3. Add build marker to toc

    See: source/test_cases/index.rst

Autobuild

See: bin/autobuild.cmd

Extensions

Codeblock

OdtParser allows to include codeblocks in odt files.

  1. Create paragraph with text "```"

    It opens the codeblock

  2. Paste some code
  3. Create paragraph with text "```"

    It closes the codeblock

  4. Set "source code" character style for the codeblock

About

OdtParser allows to include odt files in sphinx-doc

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published