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

Publish Jupytext on ReadTheDocs #168

Closed
mwouts opened this issue Feb 2, 2019 · 2 comments
Closed

Publish Jupytext on ReadTheDocs #168

mwouts opened this issue Feb 2, 2019 · 2 comments
Labels
help wanted Extra attention is needed

Comments

@mwouts
Copy link
Owner

mwouts commented Feb 2, 2019

The Jupytext extension #86 has a link to Jupytext on ReadTheDocs, but the documentation there is currently empty...
@mwouts mwouts added the help wanted Extra attention is needed label Feb 3, 2019
@mwouts
Copy link
Owner Author

mwouts commented Feb 3, 2019

I'd like to display our README.md on readthedocs, but I'd prefer not to maintain a copy of that file into a docs folder... Anyone knows how to configure sphinx or mkdocs to achieve that?

mwouts added a commit that referenced this issue Feb 3, 2019
@mwouts
Sphinx on README.md
c8ba17f 
#168
@mwouts
Copy link
Owner Author

mwouts commented Feb 6, 2019

Readthedocs started working when the README was updated. The commit above seems to have been enough.

@mwouts mwouts closed this as completed Feb 6, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
help wanted Extra attention is needed
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@mwouts