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

[WIP] Switch to pydata sphinx theme #805

Merged
merged 4 commits into from
Oct 6, 2021
Merged

[WIP] Switch to pydata sphinx theme #805

merged 4 commits into from
Oct 6, 2021

Conversation

tylerpotts
Copy link
Contributor

@tylerpotts tylerpotts commented Sep 3, 2021 •
edited
Loading

Related to #759
This PR will change the docs to use the pydata sphinx theme

Remaining tasks:

  • Navigation bar will show all subheadings when opening a document

@tylerpotts
Copy link
Contributor Author

Current look:
image

costrouc
costrouc requested changes Sep 3, 2021
View reviewed changes
Copy link
Member

@costrouc costrouc 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 adding this @tylerpotts . We definitely needed this. Just some missing content and a commented out section that needs to be removed.

docs/conf.py Outdated Show resolved Hide resolved
docs/source/user_guide/index.md Outdated Show resolved Hide resolved
docs/source/installation/index.md Outdated Show resolved Hide resolved
docs/source/dev_guide/index.md Show resolved Hide resolved
@tylerpotts
Copy link
Contributor Author

@costrouc Thanks for the review! I think I prematurely tagged you on this. I'm still working on getting the functionality/flow of the docs working and then I'll go back and add content to the pages you tagged. Will be working more on this Monday

I'll take you off as a revier for now, and add you back once it's ready to review again

@tylerpotts tylerpotts requested review from costrouc and removed request for costrouc September 3, 2021 20:38
@tylerpotts
Copy link
Contributor Author

@costrouc This is ready to review. We can discuss if the version on the bottom right is still necessary. Definitely more that can be done here, but I think this is in a good place to merge

costrouc
costrouc requested changes Sep 8, 2021
View reviewed changes
Copy link
Member

@costrouc costrouc left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Merge the source blocks but otherwise looks good!

costrouc
costrouc requested changes Sep 24, 2021
View reviewed changes
Copy link
Member

@costrouc costrouc left a comment

Choose a reason for hiding this comment

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

@tylerpotts the docs/requirements.txt need to be updated to include pydata_sphinx_theme

@tylerpotts
Copy link
Contributor Author

@costrouc It's already in the requirements:
https://github.com/Quansight/qhub/blob/change_docs_theme/docs/requirements.txt#L17

Not sure how it originally got there, but that's why it's not showing in the PR

@costrouc costrouc merged commit 59c7bad into main Oct 6, 2021
@costrouc costrouc deleted the change_docs_theme branch October 6, 2021 14:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@costrouc costrouc costrouc 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.
2 participants
@tylerpotts @costrouc