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.

Sign up for GitHub

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

Jump to bottom

Generate scenario docs #1171

Merged
merged 1 commit into from
Nov 21, 2022
Merged

Generate scenario docs #1171

merged 1 commit into from
Nov 21, 2022

Conversation

yifanmai
Copy link
Collaborator

@yifanmai yifanmai commented Nov 18, 2022 •
edited
Loading

Use mkdocstrings to autogenerate docs for all scenarios.

Addresses #1159
Fixes #1164

percyliang
percyliang approved these changes Nov 19, 2022
View reviewed changes
Copy link
Contributor

@percyliang percyliang left a comment

Choose a reason for hiding this comment

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

Why are all the colons removed - because they are section headings? What will the final rendering look like?

@yifanmai
Copy link
Collaborator Author

Yes, the colon removal was for the section issue in #1159. I'll try to add them back in a later PR.

Here's what the rendering looks like:

scenario_docs

@yifanmai yifanmai merged commit e2bcaa3 into main Nov 21, 2022
@yifanmai yifanmai deleted the yifanmai/1159-docs-scenarios branch November 21, 2022 19:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@percyliang percyliang percyliang approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Add documentation to ReadTheDocs
2 participants
@yifanmai @percyliang