[CAT-814] Clean up documentation for Readme #278
Merged
Conversation
This file contains 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
…265) * added dockerfile for generating markdown from rst, and updated sphinx config to generate markdown instead of html * moving logic for creating docs to separate script
meghanhickey
force-pushed
the
meghan/cat-814
branch
from
7a4fcfc
to
6ecc07c
Compare
meghanhickey
force-pushed
the
meghan/cat-814
branch
from
6ecc07c
to
fe527d1
Compare
goatrocks
approved these changes
Nov 8, 2023
| @@ -1,21 +1,7 @@ | |||
| ****************************** | |||
| indicoio Python Client Library | |||
| Indico Python Client Library | |||
There was a problem hiding this comment.
Should we add any intro or guidance on using the guide here? Probably worth asking technical writing?
goatrocks
added a commit
that referenced
this pull request
Feb 8, 2024
* [CAT-803] Add dockerfile for container that generates markdown docs (#265) * added dockerfile for generating markdown from rst, and updated sphinx config to generate markdown instead of html * moving logic for creating docs to separate script * [CAT-806] adding github pr script (#272) * adding github pr script * [CAT-806] generate frontmatter for markdown files (#275) * run script to add frontmatter yaml * wip * change base branch * save harness pipeline yaml * only mkdir if it doesn't already exist --------- Co-authored-by: MC <meg.cahill@indico.io> Co-authored-by: meghanhickey <meghan.hickey@indico.io> * [CAT-814] Clean up documentation for Readme (#278) * adding github pr script * run script to add frontmatter yaml * wip * change base branch * save harness pipeline yaml * clean up rst files * [CAT-803] Add dockerfile for container that generates markdown docs (#265) * added dockerfile for generating markdown from rst, and updated sphinx config to generate markdown instead of html * moving logic for creating docs to separate script * move dockerfile and scripts for building docs to indico-readme repo * WIP * adding github pr script * adding script to build docs * use branch of indico-readme * edit doc links so they work in readme; remove uninformationive Raises from docstrings * edit docstrings --------- Co-authored-by: MC <meg.cahill@indico.io> * update harness pipeline * address brigid's comments * more responses to brigid comments --------- Co-authored-by: micah cahill <micah.cahill@indicodata.ai> Co-authored-by: MC <meg.cahill@indico.io>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary