Add licensing guidelines to ReadtheDocs #21
Conversation
| source_suffix = { | ||
| '.rst': 'restructuredtext', | ||
| '.md': 'markdown', | ||
| } |
There was a problem hiding this comment.
Was super happy to see how easy it was to enable both restructuredtext and markdown! Yay sphinx!
There was a problem hiding this comment.
Yay! This is awesome
|
|
||
|
|
||
|
|
||
| # -- Options for HTML output ------------------------------------------------- | ||
| # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output | ||
|
|
||
| html_theme = 'alabaster' | ||
| html_theme = 'sphinx_rtd_theme' |
There was a problem hiding this comment.
Going with this for now, but definitely open to ideas for other themes we might want to use.
| and shows the different categories of licenses available and the types of licenses that support their respective | ||
| requirements. | ||
|
|
||
|  |
There was a problem hiding this comment.
I was having lots of trouble trying to get HTML to render in sphinx/ReadtheDocs, so I decided to just show a static image of the table instead 🤷🏻 . Maybe we can get embedded HTML working in a future PR?
There was a problem hiding this comment.
Looks like the table caption is above the table again. We might want to re-make that png and add the caption in the .md file below the image at some point
bourque
requested review from
alex7ware,
kjbrooks and
vmartinez-cu
and removed request for
alex7ware
|
Just noticed that the Read the Docs build failed. Looks like an issue with the module 'myst_parser' |
|
I think I solved the RTD build issues. These updates are now 'live' here: https://lasp-developer-guide--21.org.readthedocs.build/en/21/licensing.html |
This PR moves the licensing guideline to under the
sphinxsource tree, thus allowing it to render in ReadTheDocs. I also made a few style changes to the licensing markdown file, and enabled support for markdown in the sphinx config.