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

Set Up Read The Docs with Sphinx #8

Closed
mac-gallagher opened this issue Aug 24, 2019 · 6 comments · May be fixed by #19
Closed

Set Up Read The Docs with Sphinx #8

mac-gallagher opened this issue Aug 24, 2019 · 6 comments · May be fixed by #19
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@mac-gallagher
Copy link
Owner

mac-gallagher commented Aug 24, 2019 •
edited
Loading

First step is to just set up Read The Docs using whatever documentation already exists in the project. Adding more coverage will come later!

@purcellconsult is undertaking this project
@mac-gallagher mac-gallagher added documentation Improvements or additions to documentation enhancement New feature or request labels Aug 24, 2019
@purcellconsult
Copy link

Here's what I came up with thus far: https://shuffle-docs.readthedocs.io/en/latest

@mac-gallagher
Copy link
Owner Author

mac-gallagher commented Aug 30, 2019 •
edited
Loading

Hey @purcellconsult,

Can you fork the repo and make a pull request with your changes? Let’s follow the same docs folder structure as in this example. I will follow up with some more comments there.

Also, can we rename the url host to “Shuffle” instead of “Shuffle-Docs”?

@mac-gallagher
Copy link
Owner Author

Hey @purcellconsult,

I have just checked and it looks like it is up to me to do most of the setup here (such as re-naming the url host).

However, on second thought, I think we should hold off on setting up a Read The Docs for this repo. I'm not sure the project is complicated enough at the moment to warrant a new home for the documentation. If things change, I'll let you know and we can continue working on this. Sorry for not figuring this out earlier. Thanks for your time, and I hope you learned something new in the meantime!

@purcellconsult
Copy link

purcellconsult commented Sep 3, 2019 via email •
edited
Loading

@mac-gallagher
Copy link
Owner Author

@purcellconsult as I mentioned you can still open a pull request which includes your rst file. We can leave it there for now and come back to it if/when the time is right.

@purcellconsult
Copy link

purcellconsult commented Sep 3, 2019 via email

@purcellconsult purcellconsult mentioned this issue Sep 7, 2019
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Set Up Read The Docs with Sphinx purcellconsult/Shuffle
2 participants
@purcellconsult @mac-gallagher