This is a project for learning how to use mkdocs and readthedocs website.
In this webpage I will include the features I found useful in mkdocs.
I need cross reference.
Read the docs will by default create outline for a page, can I disable that, or is it better to disable that?
A few things to learn. How to add new pages.
How to reference other pages?
mkdocs new [dir-name]- Create a new project.
mkdocs serve- Start the live-reloading docs server.
mkdocs build- Build the documentation site.
mkdocs help- Print this help message.
mkdocs.yml # The configuration file. docs/ index.md # The documentation homepage. ... # Other markdown pages, images and other files.
Try to use
conf.py for building sphinx docs.