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

Update Documentation from Py2 to Py3 #123

Closed
JamesPHoughton opened this issue Jul 25, 2017 · 1 comment · Fixed by #223
Closed

Update Documentation from Py2 to Py3 #123

JamesPHoughton opened this issue Jul 25, 2017 · 1 comment · Fixed by #223

Comments

@JamesPHoughton
Copy link
Collaborator

Continuing the thread from #53 (comment)

Hi @osychenko,
Moving the thread to a new issue - updating documentation deserves it's own discussion!

It would be super fantastic to have your help with the docs. Right now, I use sphinxdoc to format restructured text into the format you see on readthedocs. Edits are made to .rst files in the docs directory of the repository. Then you can build them on your local machine using the sphinx package, and view the HTML in the _build directory. Took me a few tries to work that out, but the sphinx package documentation is pretty good. (It had better be...) The basic syntax is to, once changes are made:

cd docs\
make clean
make html

If you fork the PySD repository and make changes, then when you PR and I merge everything back into the master branch, readthedocs will load from the PySD master repo and rebuild and serve them.

@sepiatone
Copy link
Contributor

Hi James,

I made some changes to the documentation - minor stuff while I understand how sphinx and restructured text work. I've created a pull request for you perusal.

Aditya

@JamesPHoughton JamesPHoughton linked a pull request Dec 17, 2020 that will close this issue
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 a pull request may close this issue.

2 participants