asciidoc  10.2.0
About: AsciiDoc is a text document format for writing notes, documentation, articles, books, ebooks, slideshows, web pages, man pages and blogs. AsciiDoc files can be translated to many formats including HTML, PDF, EPUB, man page (requires Python 3.5 or later).
  Fossies Dox: asciidoc-10.2.0.tar.gz  ("unofficial" and yet experimental doxygen-generated source code documentation)  
asciidoc Documentation

Some Fossies usage hints in advance:

  1. To see the Doxygen generated documentation please click on one of the items in the steelblue colored "quick index" bar above or use the side panel at the left which displays a hierarchical tree-like index structure and is adjustable in width.
  2. If you want to search for something by keyword rather than browse for it you can use the client side search facility (using Javascript and DHTML) that provides live searching, i.e. the search results are presented and adapted as you type in the Search input field at the top right.
  3. Doxygen doesn't incorporate all member files but just a definable subset (basically the main project source code files that are written in a supported language). So to search and browse all member files you may visit the Fossies asciidoc-10.2.0.tar.gz contents page and use the Fossies standard member browsing features (also with source code highlighting and additionally with optional code folding).
README.md

AsciiDoc.py

Build Status codecov PyPI version

AsciiDoc is a text document format for writing notes, documentation, articles, books, ebooks, slideshows, web pages, man pages and blogs. AsciiDoc files can be translated to many formats including HTML, PDF, EPUB, man page.

AsciiDoc.py is a legacy processor for this syntax, handling an older rendition of AsciiDoc. As such, this will not properly handle the current AsciiDoc specification. It is suggested that unless you specifically require the AsciiDoc.py toolchain, you should find a processor that handles the modern AsciiDoc syntax.

AsciiDoc.py is highly configurable: both the AsciiDoc source file syntax and the backend output markups (which can be almost any type of SGML/XML markup) can be customized and extended by the user.

Prerequisites

AsciiDoc.py is written in Python so you need a Python interpreter (version 3.5 or later) to execute asciidoc(1). You can install Python using the package manager for your OS or by downloading it from the official Python website http://www.python.org.

Additionally, you will need:

  • DocBook XSL Stylesheets 1.76.1
  • xsltproc (libxml 20706, libxslt 10126 and libexslt 815).
  • w3m 0.5.2
  • dblatex 0.3
  • FOP 0.95

to enable the full AsciiDoc.py toolchain.

Obtaining AsciiDoc.py

Documentation and installation instructions are on the AsciiDoc.py website https://asciidoc.org/. Simply, you should use use pip to install it:

pip3 install asciidoc

Contributing

To contribute and test your changes, you will need to install:

  • flake8
  • pytest
  • pytest-mock

To lint the codebase: python3 -m flake8

AsciiDoc.py has the following types of tests:

  1. doctests: python3 -m asciidoc.asciidoc --doctest
  2. unit tests: python3 -m pytest
  3. integration tests: python3 tests/testasciidoc.py