Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

move developer Readme/markdown docs to main documentation #73

Merged
merged 12 commits into from Mar 26, 2021

Conversation

nhoening
Copy link
Contributor

@nhoening nhoening commented Mar 24, 2021

Moving lots of content we have from markdown to restructuredText/Sphinx. I used the tool M2R and then moved on by hand.

Reviewing is best done by running make update-docs and looking through the new pages (Getting started, Configuration and the Developer section).

I don't believe these additions clash with #65.

@nhoening nhoening linked an issue Mar 24, 2021 that may be closed by this pull request
@nhoening nhoening changed the title move Readme/markdown docs to main documentation move developer Readme/markdown docs to main documentation Mar 24, 2021
@nhoening nhoening requested a review from Flix6x March 24, 2021 22:24
@nhoening nhoening added the documentation Improvements or additions to documentation label Mar 24, 2021
@nhoening nhoening self-assigned this Mar 25, 2021
Copy link
Contributor

@Flix6x Flix6x left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Two smaller comments, and I committed some fixes myself. Really nice to see our documentation coming together like this!

documentation/dev/introduction.rst Outdated Show resolved Hide resolved
documentation/dev/api.rst Outdated Show resolved Hide resolved
@nhoening nhoening merged commit 727180f into main Mar 26, 2021
@nhoening nhoening deleted the issue-55-Move_Readmes_to_Sphinx_docs branch March 26, 2021 18:40
@Flix6x Flix6x mentioned this pull request Mar 26, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Move Readmes to Sphinx docs
2 participants