jamie/ptulsconv
1
0
Fork 0
mirror of https://github.com/iluvcapra/ptulsconv.git synced 2025-12-31 17:00:46 +00:00
Code Issues Packages Projects Releases Wiki Activity

Trying to make refs look nice

Browse Source
This commit is contained in:
Jamie Hardt
2022-11-19 21:37:50 -08:00
parent adb80eb174
commit d50e45882b
1 changed files with 11 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
docs/source/dev/theory.rst
View File

@@ -4,19 +4,20 @@ Theory of Operation
Execution Flow When Producing "doc" Output
------------------------------------------
#. The command line argv is read in `__main__.main()`,
which calls `commands.convert()`
#. `commands.convert()` reads the input with `docparser.doc_parser_visitor()`,
which uses the `parsimonious` library to parse the input into an abstract
#. The command line argv is read in :py:func:`ptulsconv.__main__.main()`,
which calls :py:func:`ptulsconv.commands.convert()`
#. :func:`ptulsconv.commands.convert()` reads the input with
:func:`ptuslconv.docparser.doc_parser_visitor()`,
which uses the ``parsimonious`` library to parse the input into an abstract
syntax tree, which the parser visitor uses to convert into a
`docparser.doc_entity.SessionDescriptor`, which structures all of the data
in the session output.
:class:`ptulsconv.docparser.doc_entity.SessionDescriptor`,
which structures all of the data in the session output.
#. The next action based on the output format. In the
case of the "doc" output format, it runs some validations
on the input, and calls `commands.generate_documents()`.
#. `commands.generate_documents()` creates the output folder, creates the
Continuity report with `pdf.continuity.output_continuity()` (this document
on the input, and calls :func:`ptulsconv.commands.generate_documents()`.
#. :func:`ptulsconv.commands.generate_documents()` creates the output folder, creates the
Continuity report with :func:`ptulsconv.pdf.continuity.output_continuity()` (this document
requires some special-casing), and at the tail calls...
#. `commands.create_adr_reports()`, which creates folders for
#. :func:`ptulsconv.commands.create_adr_reports()`, which creates folders for
(FIXME finish this)