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

theme docs #25

Merged
merged 24 commits into from Oct 19, 2021
Merged

theme docs #25

merged 24 commits into from Oct 19, 2021

Conversation

davidsmejia
Copy link
Contributor

@davidsmejia davidsmejia commented Oct 13, 2021

  • Adds instructions for setting up to the readme
  • Adds and customizes sphinx_rtd_theme to project
  • Adds dev server to see live updates after saving file
  • changes index.rst to index.md

Screen Shot 2021-10-14 at 11 47 41 AM

Screen Shot 2021-10-14 at 11 47 59 AM

@allyhawkins
Copy link
Member

Generally this looks pretty good to me and I'm good with the overall look. I was able to test it locally to following the instructions in the readme and everything works as it should. The only thing that jumps out at me here is that the title of the docs is kind of weird still. Is there a way to change that so it just says like ScPCA Portal Documentation?

@davidsmejia
Copy link
Contributor Author

Generally this looks pretty good to me and I'm good with the overall look. I was able to test it locally to following the instructions in the readme and everything works as it should. The only thing that jumps out at me here is that the title of the docs is kind of weird still. Is there a way to change that so it just says like ScPCA Portal Documentation?

I added a blurb and changed the name of the document. Also updated the TOC to not be quite so default in appearance.

@davidsmejia
Copy link
Contributor Author

updated screen shots to reflect recent changes

docs/index.md Outdated Show resolved Hide resolved
Copy link
Member

@jashapiro jashapiro left a comment

Choose a reason for hiding this comment

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

LGTM! The only thing I want comment on is the link to the page source in the upper right. I don't see any reason to include that as is, but I note that http://docs.refine.bio/ links back to github there, which seems to make a bit more sense.

Copy link
Member

@jaclyn-taroni jaclyn-taroni left a comment

Choose a reason for hiding this comment

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

LGTM also! But before we merge this, I'll just ask you to add a .gitignore that will help prevent us from doing silly things down the line & have unstaged files lists look more reasonable:

# ignore virtualenv & local build
env
docs/_build

Co-authored-by: Ally Hawkins <54039191+allyhawkins@users.noreply.github.com>
@dvenprasad
Copy link
Member

Can it say ScPCA Portal Docs?

@davidsmejia davidsmejia merged commit bd663be into main Oct 19, 2021
@davidsmejia davidsmejia deleted the davidsmejia/theme-docs branch October 19, 2021 16:56
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.

None yet

5 participants