Skip to content

Add recommonmark to the list of required Sphinx extensions #345

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

Merged

Conversation

mwouts
Copy link
Contributor

@mwouts mwouts commented Sep 26, 2020

This PR fixes #344 .

With this small change, the local rendering of the docs is much better, both for the index, and for the feature page (compare the screenshots below to those on #344 to see the improvement)
Screenshot from 2020-09-26 09-20-15
Screenshot from 2020-09-26 09-20-55

Copy link
Member

@kevin-bates kevin-bates left a comment

Choose a reason for hiding this comment

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

Thanks Marc!

@kevin-bates
Copy link
Member

hi Marc - thanks for the contribution.

I've been looking at the build failures and have found they are related to a traitlets version increment from (at least) 4.3.3 to 5.0.4. I can reproduce the test failure in using the pip freeze output of the failing python 3.8 tests. In diffing the same output from the python 3.6 tests, there are several differences, but traitlets seemed the most suspicious to me and I was right. Reverting to traitlets 4.3.3 in py 3.8 allowed the test to pass.

I have not determined exactly why traitlets is affecting the swagger facility (there are several test failures, but the CI must be set up to stop on first failure). Given the simplicity of this change and the fact that it introduces nothing related to the core package and its tests, I'm going ahead with the merge.

We will probably need to cap traitlets in JKG for now, but that's a different PR (and perhaps even shorter than this one! 😄 ).

@kevin-bates kevin-bates merged commit e2f6010 into jupyter-server:master Sep 26, 2020
@mwouts
Copy link
Contributor Author

mwouts commented Sep 27, 2020

Thank you Kevin. I'm sorry to see that this PR gives you much more work than expected! Also I see that the doc status is failing Documentation Status, maybe we need to change something on the RTD website as well?

To compile the docs locally I have used

cd docs
conda env create --file environment.yml
conda activate kernel_gateway_docs
make html

@blink1073 blink1073 added this to the 2.5 milestone Apr 19, 2021
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.

Improve the doc formating on RTD
3 participants