[Piuparts-devel] doc files for piuparts python 3

[Herbert Fortes]

Hi,

I checked before about the build depends for the doc 
files.

asciidoc is Python 2. And the project suggests asciidoctor
as a replacement. asciidoctor has a Debian package and it
is a ruby project.

Homepage: http://asciidoctor.org

Description: AsciiDoc to HTML rendering for Ruby
 Asciidoctor is a pure Ruby processor for converting AsciiDoc source files and
 strings into HTML 5, DocBook 4.5, DocBook 5.0 and other formats.


Some guys ported asciidoc to python 3[0]. But there is no
Debian package for it.

[0] - https://github.com/asciidoc3/asciidoc3


It seems that it is a common choice to use python3-sphinx.
The 'apt show python3-sphinx'.

Sphinx is a tool for producing documentation for Python projects, using
 reStructuredText as markup language.
 .
 Sphinx features:
  * HTML, CHM, LaTeX output,
  * Cross-referencing source code,
  * Automatic indices,
  * Code highlighting, using Pygments,
  * Extensibility. Existing extensions:
    - automatic testing of code snippets,
    - including docstrings from Python modules.
 .
 This package includes Python 3 modules.

I was watching a video lesson - less than 5 minutes :
https://realpython.com/lessons/setting-sphinx-example-project-and-scaffolding/

There are more videos teaching how to update, preview .rst files
(can use .txt),  a subheading configuration, hosting the doc at 
readthedocs - these for members.



Regards,
Herbert