#128 Sphinx + ReadTheDocs build setup Pull request...
# openlane
g
#128 Sphinx + ReadTheDocs build setup Pull request opened by wgryncewicz This PR creates basic config for automated documentation build/publish using Sphinx and RTD. As the documentation is in markdown,
recommonmark
was used for compability. Solves #127 The RTD preview is currently available here: https://openlane-docs.readthedocs.io/en/rtd-w-markdown/ Currently recognized issues: •
recommonmark
does not support tables. This was patched by
sphinx_markdown_tables
extension, but some tables still did not render. • static image paths in MD are not linked properly in HTML • documentation points to some code files, such as
.cfg
or
.tcl
. These are not linked in HTML. efabless/openlane Travis CI: Build Created
✔️ 1