docs: add sphinx-docs-starter-pack base#185
Closed
cjdcordeiro wants to merge 3 commits intocanonical:mainfrom
Closed
docs: add sphinx-docs-starter-pack base#185cjdcordeiro wants to merge 3 commits intocanonical:mainfrom
cjdcordeiro wants to merge 3 commits intocanonical:mainfrom
Conversation
Collaborator
Author
|
Note the automatically-built RTD page within the checks -> https://canonical-chisel--185.com.readthedocs.build/en/185/ |
This commit adds a skeleton of the documentation based on docs starter pack: https://canonical-starter-pack.readthedocs-hosted.com/latest/. Note that the docs themselves are not updated. Only necessary files and hacks are introduced in this commit.
Read reuse/substitutions.yaml if it exists into myst_substitutions to reuse content with simple markdown. Additionally, delete reuse/links.txt since we are not using reStructuredText. This commit also updates a few misc settings in conf.py.
f9d1c51 to
c603b11
Compare
1 task
letFunny
approved these changes
Jan 7, 2025
Collaborator
letFunny
left a comment
There was a problem hiding this comment.
Discussed offline, this is all the code that the starter pack generates automatically.
Collaborator
Author
|
Moving docs to new repo -> github.com/canonical/chisel-docs. Cloning this PR at canonical/chisel-docs#1 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR follows the instructions from https://github.com/canonical/sphinx-docs-starter-pack to add the baseline sphinx-docs-start-pack upon which the coming docs will be based on.
The
.sphinxfolder is pretty much a boilerplate and should stay in sync with https://github.com/canonical/sphinx-docs-starter-pack.RTD has already been connected to the Chisel project.