frost/docs
Hal Wine ceab2ae40b
[DOC] Support Markdown in docs (#376) (#381)
* Support Markdown in documents

Uses `myst_parser` to process Markdown files in the Sphinx workflow.
Using that, included the top level `README.md` as the "Overview" in the
rendered docs.

Some tweaks were needed to have `README.md` render correctly in rendered
docs. Still renders okay via GitHub.

Add a makefile target `doc-preview` to serve the locally built docs.

Fix some links in the README file.

Co-authored-by: Sven Marnach <sven@mozilla.com>
2020-10-08 17:36:16 -07:00
..
.nojekyll Docs & FAQ (#318) 2020-08-04 14:26:59 -07:00
Architecture.rst Docs & FAQ (#318) 2020-08-04 14:26:59 -07:00
CodingConventions.rst Add importance of supporting --offline (#326) 2020-10-05 11:18:31 -07:00
ContributingDocumentation.rst [DOC] Support Markdown in docs (#376) (#381) 2020-10-08 17:36:16 -07:00
FAQ.rst Docs & FAQ (#318) 2020-08-04 14:26:59 -07:00
Makefile Revert "Add markdown support to our Sphinx docs (#374)" 2020-10-04 10:11:29 -07:00
MozillaDeployment.rst [DOC] fix broken links in docs 2020-10-08 14:50:40 -07:00
NewServices.rst Add importance of supporting --offline (#326) 2020-10-05 11:18:31 -07:00
conf.py [DOC] Support Markdown in docs (#376) (#381) 2020-10-08 17:36:16 -07:00
frost-snowman-logo.png Fix name of snowman logo. (#327) 2020-09-01 08:02:07 -07:00
index.rst [DOC] Support Markdown in docs (#376) (#381) 2020-10-08 17:36:16 -07:00
readme-include.md [DOC] Support Markdown in docs (#376) (#381) 2020-10-08 17:36:16 -07:00
requirements.txt [DOC] Support Markdown in docs (#376) (#381) 2020-10-08 17:36:16 -07:00