Disclaimer: This is a private initiative and private project, not affiliated with any company and done exclusively in the free time.
Disclaimer: The information in the repo provided for informational purposes only.
Disclaimer: The documentation content provided in the repo is authored by AUTOSAR and protected by copyright and other types of intellectual property rights. The word AUTOSAR and the AUTOSAR logo are registered trademarks.
I have the following goals when creating the repo:
- AUTOSAR to be have state-of-the-art documentation as code.
- AUTOSAR documentation to be contained in one place (no-go for downloading hundreds of PDFs).
- AUTOSAR as web documentation with clickable links and PDFs.
I parse the PDF files
using the Apache tika toolkit,
in particularly I used the python bindings for tika.
From the parsed text I created
the corresponding reStructuredText
files which are rendered to static HTML pages or PDFs
using the python sphinx documentation tool.
The sphinx python tool creates
html or latex documentation sources from the
reStructuredText or Markdown sources.
In order to create documentation:
-
install
python 3+ -
install sphinx with
pip install sphinx -
install sphinx_rtd_theme with
pip install sphinx_rtd_theme
Build the HTML documentation:
sphinx-build -b html source build/htmlBuild the LaTeX documentation:
sphinx-build -b latex source build/latexDr. Konstantin Selyunin, for suggestions / questions / comments please contact selyunin [dot] k [dot] v [at] gmail [dot] com.