Homepage for the Rust for Pythonist documentation
This project holds the source code of the documentation publically available at the following URL:
http://www.great-a-blog.co/rust-for-pythonists/
I'm not a good technical writer. That's a job and some are paid for this talent. My main goal is just to help Python programmers to learn this new language.
Also, I'm not native english speaker. If you find mistakes, please send me at least an email. You can use this address: gaetan [ at ] xeberon.net
To fork this documentation and edit it offline, simply:
- fork this project (https://github.com/Stibbons/rust-for-pythonists)
- edit your changes
- submit to me a Pullrequest (https://help.github.com/articles/creating-a-pull-request)
That's all. Once accepted, the official documentation will be automatically updated.
- You need Python and pip to build this documentation
- I use sphinx-builder to build this documentation (http://sphinx-doc.org/index.html)
- with the cloud theme (http://pythonhosted.org/cloud_sptheme/cloud_theme.html)
- I've added the bash script and batch files to support Linux, Mac OS (with homebrew) and Windows compilations.
- With pip, install easily sphinx with
pip install sphinx(on windows you need to download the official installer) - The easiest is to use the
requirements.txtfile:pip install -r requirements.txt - On windows you need msysw to have the unix tools like
bash,make...
This github project is linked to the Read my Doc service, which triggers a rebuild of the online documentation when changes are merged.
A travis build is also triggered (I prefere the notification from travis-ci).
- GitHub: https://github.com/Stibbons/rust-for-pythonists/
- Read the Docs: https://readthedocs.org/projects/rust-for-pythonists/
- Travis-CI: https://travis-ci.org/Stibbons/rust-for-pythonists
I mainly use Sublime Text 3 as my main editor and its quite usefull reStructuredText plugin
- Sublime Text 3: http://www.sublimetext.com/
- reStructuredText plugin: https://github.com/dbousamra/sublime-rst-completion
- Try to keep files short. Reading a loooooooooong file is annoying. Don't try to detail everything. Just stick to the essential matters.
- Keep organised. Chapters are splitted in different files, once by section, this helps finding where to modify when a change is to be done. Keep the same structure.