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

Add documentation #13

Merged
merged 17 commits into from
Sep 2, 2022
Merged

Add documentation #13

merged 17 commits into from
Sep 2, 2022

Conversation

josh146
Copy link
Member

@josh146 josh146 commented Sep 1, 2022

No description provided.

@github-actions
Copy link
Contributor

github-actions bot commented Sep 1, 2022

Hello. You may have forgotten to update the changelog!
Please edit .github/CHANGELOG.md with:

  • A one-to-two sentence description of the change. You may include a small working example for new features.
  • A link back to this PR.
  • Your name and GitHub username in the contributors section.

@josh146 josh146 linked an issue Sep 1, 2022 that may be closed by this pull request
Copy link
Collaborator

@Mandrenkov Mandrenkov left a comment

Choose a reason for hiding this comment

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

Excellent work, @josh146! 🎉

We probably should have had this ready for the v0.1.0 release but better late than never!

README.rst Outdated Show resolved Hide resolved
README.rst Show resolved Hide resolved
doc/_templates/autosummary/base.rst Outdated Show resolved Hide resolved
doc/code.rst Outdated Show resolved Hide resolved
doc/conf.py Show resolved Hide resolved
doc/requirements.txt Outdated Show resolved Hide resolved
doc/started.rst Outdated Show resolved Hide resolved
@@ -25,7 +26,7 @@ def setup(app):
"details": DetailsDirective,
"gallery-item": GalleryItemDirective,
"index-card": IndexCardDirective,
"related-demo": RelatedDemoDirective,
"related": RelatedDemoDirective,
Copy link
Collaborator

Choose a reason for hiding this comment

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

Doesn't related-demo match the naming of the other directives better? 🤔

Copy link
Member Author

Choose a reason for hiding this comment

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

This was me sneaking in a feature 😬 I realized that the sidebar section just says "Related", and I realized this could be useful beyond just demos

Copy link
Collaborator

Choose a reason for hiding this comment

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

Should we rename the directive then too, @josh146?

Suggested change
"related": RelatedDemoDirective,
"related": RelatedDirective,

Copy link
Member Author

Choose a reason for hiding this comment

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

Oops, I should have done that at the time

xanadu_sphinx_theme/layout.html Outdated Show resolved Hide resolved
xanadu_sphinx_theme/static/xanadu.css_t Outdated Show resolved Hide resolved
josh146 and others added 5 commits September 2, 2022 23:34
Co-authored-by: Mikhail Andrenkov <Mandrenkov@users.noreply.github.com>
Co-authored-by: Mikhail Andrenkov <Mandrenkov@users.noreply.github.com>
Co-authored-by: Mikhail Andrenkov <Mandrenkov@users.noreply.github.com>
Copy link
Collaborator

@Mandrenkov Mandrenkov left a comment

Choose a reason for hiding this comment

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

Thanks for addressing all the feedback! 💯

@josh146 josh146 merged commit 7c53d80 into master Sep 2, 2022
@josh146 josh146 deleted the docs branch September 2, 2022 17:08
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.

Add Sphinx documentation
2 participants