ardvansomeren / avs1416-repository-template

Template for a new repository using Read the Docs
https://docs.readthedocs.io/en/stable/tutorial/
0 stars 0 forks source link

no module myst_parser #2

Open ardvansomeren opened 1 year ago

ardvansomeren commented 1 year ago

Added the myst_parser extension to the configuration in conf.py. but it is not loaded. Should be loaded with a pip install. Have to figure out: a is it neccesary to parse MD files b how to add a module to the configuration when it needs to be available for read the docs c do I need Sphinx when I do not use the .rst files

ardvansomeren commented 1 year ago

a first step - take the coniguration out of the conf.py file.

in the example https://cerodell.github.io/sphinx-quickstart-guide/build/html/markdown.html this was the instruction, so I am afraid that this isn't enough.

Although the build was succesful, the entry of the mymarkdown.md wasn't visable. Next step, explicit add, the md extension to the entry

This isn't the solution eihter

ardvansomeren commented 1 year ago

b second step - add a module

not yet found a answer to that question. first try c - change to index.md

I think that I need to add those modules on the local python environement...

ardvansomeren commented 1 year ago

c not using Sphinx, but MkDocs instead

Sphinx lessons: https://coderefinery.github.io/sphinx-lesson/toctree/

I found this link https://github.com/readthedocs/readthedocs.org/issues/1277 and stumbled upon the RTD publication. She figured it out... So let's see of we can go this way. https://djangae.readthedocs.io/en/latest/

https://mkdocs.readthedocs.io/en/stable/ so lets figure out how to use MkDocs instead

https://github.com/readthedocs-examples/example-mkdocs-basic https://docs.readthedocs.io/en/stable/intro/getting-started-with-mkdocs.html