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

DOC: Update documentation files to allow Sphinx to generate html documentation #708

Merged

Conversation

imikejackson
Copy link
Contributor

No description provided.

@imikejackson imikejackson changed the title DOC: Convert markdown docs to restructured text (for use with Sphinx) [WIP] DOC: Convert markdown docs to restructured text (for use with Sphinx) Oct 4, 2023
@imikejackson imikejackson force-pushed the feature/sphinx_docs branch 4 times, most recently from a8cb052 to 8e51005 Compare October 4, 2023 22:59
@imikejackson imikejackson changed the title [WIP] DOC: Convert markdown docs to restructured text (for use with Sphinx) [WIP] DOC: Use Sphinx to generate documentation Oct 5, 2023
@imikejackson imikejackson force-pushed the feature/sphinx_docs branch 4 times, most recently from 5755298 to d0b7506 Compare October 6, 2023 19:36
@imikejackson imikejackson marked this pull request as ready for review October 6, 2023 19:36
@imikejackson imikejackson changed the title [WIP] DOC: Use Sphinx to generate documentation DOC: Use Sphinx to generate documentation Oct 6, 2023
@imikejackson imikejackson changed the title DOC: Use Sphinx to generate documentation DOC: Update documentation files to allow Sphinx to generate html documentation Oct 6, 2023
@imikejackson imikejackson force-pushed the feature/sphinx_docs branch 4 times, most recently from b22511b to f2ff689 Compare October 11, 2023 15:51
Copy link
Contributor

@joeykleingers joeykleingers left a comment

Choose a reason for hiding this comment

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

Looks reasonable to me.

@imikejackson imikejackson merged commit 0f7c234 into BlueQuartzSoftware:develop Oct 13, 2023
7 checks passed
@imikejackson imikejackson deleted the feature/sphinx_docs branch October 13, 2023 00:13
imikejackson added a commit to imikejackson/simplnx that referenced this pull request Oct 20, 2024
…mentation (BlueQuartzSoftware#708)

* Dynamically generate the Parameters section for each documentation file.
* Filter doc files have had their parameter section removed and replaced with a place holder.
* Filter doc markdown have been cleaned up as best as possible

---------

Signed-off-by: Michael Jackson <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants