Skip to content

[WIP] Continue testing with new version of sphinx theme #14648

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

Closed
wants to merge 15 commits into from

Conversation

Shekharrajak
Copy link
Member

@Shekharrajak Shekharrajak commented Oct 6, 2019

Continuation of #14494

  • Latest sphinx version is used
  • Search box is working fine with new version. Custom template of searchbox is removed in this PR.
  • imgmath_image_format is not needed, since new theme is directly using the script of mathjs .
  • edit on github button added

Related PRs: https://github.com/Shekharrajak/scipy-sphinx-theme-v2/pull/42

Working copy:

@Shekharrajak
Copy link
Member Author

Generated the docs using grunt --project=docs

and deployed using surge --project doc/source/build/ --domain generated-numpy-docs-28-sphinx2.surge.sh

deployed at http://generated-numpy-docs-28-sphinx2.surge.sh

@charris
Copy link
Member

charris commented Nov 15, 2019

@Shekharrajak Do you want to keep this open?

@Shekharrajak
Copy link
Member Author

I keep testing the new theme using this branch. So it must be open for now.

@Shekharrajak Shekharrajak changed the title [Don't merge] Continue testing with new version of sphinx theme [WIP] Continue testing with new version of sphinx theme Nov 16, 2019
@Shekharrajak
Copy link
Member Author

It will be helpful if someone helps me resolving CI/CD failure.

@rgommers
Copy link
Member

I think the warnings need resolving.

For this one I think it's just doing what the warning says:

/home/circleci/repo/doc/scipy-sphinx-theme-v2/custom_sphinx_theme/scripts.html:29: RemovedInSphinx30Warning: To modify script_files in the theme is deprecated. Please insert a <script> tag directly in your theme instead.
  {% endif %}
/home/circleci/repo/doc/scipy-sphinx-theme-v2/custom_sphinx_theme/scripts.html:29: RemovedInSphinx30Warning: To modify script_files in the theme is deprecated. Please insert a <script> tag directly in your theme instead.
  {% endif %}

Here we want to be using MathJax instead of pngmath I believe:

WARNING: dvipng command 'dvipng' cannot be run (needed for math display), check the imgmath_dvipng setting

This is configured in doc/source/conf.py.

@Shekharrajak
Copy link
Member Author

Thanks @rgommers ! Working on it.

@Shekharrajak
Copy link
Member Author

Finally all green 🎉

@Shekharrajak
Copy link
Member Author

NEPs doc generated using SPHINXOPTS=-q make -e html in doc/neps folder and demo link is : http://generated-numpy-neps-sphinx2.surge.sh/

@Shekharrajak
Copy link
Member Author

Shekharrajak commented Nov 22, 2019

latest devdoc after these changes : http://generated-numpy-docs-14648-sphinx2.surge.sh

@rgommers
Copy link
Member

Looking at most pages on a 13" screen, the sidebar is shifting to below all content rather than on thee right side:

image

For the reference guide pages on individual functions, the right sidebar is anyway empty:

image

Should we get rid of the right sidebar?

Other than that it looks quite good! I think we can upload this onto the doc server, which is nicer to test on than Surge. Then point more people at it:)

@Shekharrajak
Copy link
Member Author

Shekharrajak commented Nov 24, 2019

Looking at most pages on a 13" screen, the sidebar is shifting to below all content rather than on thee right side:

image

Thanks for the review. I am looking into it. It will be helpful if you can paste the link as well so that I can see the page in different device size and work on it. I found where this issue in1438 to 1220 size device . I am working on it.

For the reference guide pages on individual functions, the right sidebar is anyway empty:

image

Should we get rid of the right sidebar?

Yeah! If there are no headers/subheaders on that page then it will empty.

Other than that it looks quite good! I think we can upload this onto the doc server, which is nicer to test on than Surge. Then point more people at it:)

Yeah sure. We can put the build inside folder (may be folder name is beta for the URL numpy.org/doc/beta . Should I create a PR for that in numpy/doc repo ?

@Shekharrajak
Copy link
Member Author

Shekharrajak commented Nov 24, 2019

I fixed this issue in new commit and build : http://generated-numpy-docs-14648-2-sphinx2.surge.sh/

@Shekharrajak
Copy link
Member Author

New demo link after few fixes: http://generated-numpy-docs-14648-3-sphinx2.surge.sh/

@mattip
Copy link
Member

mattip commented Jan 12, 2020

Definitely an improvement. A few quick thoughts:

When I click on a link, the page is aligned to the left-navbar's highlighted item rather than to the top of the page.

Has the (left navbar site TOC) + (right navbar page TOC) concept been discussed? Traditionally I am used to the page TOC expanding out of the site TOC rather than appearing on a separate navbar.

The top menu has a gap of white space between the logo and the "Quick Start"

Maybe it is an artifact of using surge.sh, but the footer links are not correct.

@Shekharrajak
Copy link
Member Author

New generated numpy docs using the new commit from the scipy-sphiinx-theme : http://generated-numpy-docs-14648-5-sphinx2.surge.sh/

@Shekharrajak
Copy link
Member Author

Shekharrajak commented Jan 15, 2020

Has the (left navbar site TOC) + (right navbar page TOC) concept been discussed? Traditionally I am used to the page TOC expanding out of the site TOC rather than appearing on a separate navbar.

Yeah we have discussed it. I find that most of us don't really need the right sidebar. I think we should try to make the same in left sidebar itself.

Thanks for the input and review.

@charris
Copy link
Member

charris commented Dec 18, 2020

Ping all. Where does this stand these days?

@eric-wieser
Copy link
Member

My guess is that we've decided to let pydata handle our theme, since their theme is nice enough and has enough interested maintainers to keep it afloat - meaning this can be closed.

What theme is scipy using?

@charris
Copy link
Member

charris commented Dec 18, 2020

My guess is that we've decided to let pydata handle our theme

That is also my recollection, I'll close this. Thanks @Shekharrajak.

@charris charris closed this Dec 18, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants