Commit 608eb022 authored by Ibrahim's avatar Ibrahim
Browse files

docs: added myst_parser extension to include README.md

parent abb18f91

docs/conf.py

+3 −0
Changes for docs/conf.py: 3 added lines, 0 removed lines.
Original line number Diff line number Diff line
@@ -23,6 +23,9 @@ extensions.append('autoapi.extension') 
autoapi_type = 'python'

autoapi_dirs = ['../multirotor']



# readme.md

extensions.append('myst_parser')







# -- Options for HTML output -------------------------------------------------

docs/index.rst

+3 −1
Changes for docs/index.rst: 3 added lines, 1 removed line.
Original line number Diff line number Diff line
@@ -3,13 +3,15 @@ 
   You can adapt this file completely to your liking, but it should at least

   contain the root `toctree` directive.



Welcome to multirotor's documentation!

multirotor - UAV simulation in python

======================================



.. toctree::

   :maxdepth: 2

   :caption: Contents:



.. include:: ../README.md

   :parser: myst_parser.sphinx_





Indices and tables

docs/requirements.txt

+1 −0
Changes for docs/requirements.txt: 1 added line, 0 removed lines.
Original line number Diff line number Diff line 
sphinx

sphinx-autoapi

numpydoc

myst_parser