mirror of
https://github.com/kennethreitz/python-guide.git
synced 2026-06-05 14:50:19 +00:00
Marijn van der Zee
2f9028969c
From http://www.sphinx-doc.org/en/stable/domains.html#directive-option: > The directive will create cross-reference targets for the given options, > referencable by option (in the example case, you’d use something like > :option:`dest_dir`, :option:`-m`, or :option:`--module`). I don't think we're intending here to create cross references, we simply want to render it nicely. So just use code formatting instead. This gets rid of the last build warnings.
Hitchhiker's Guide to Python ============================ **Python Best Practices Guidebook** ----------- **Work in progress. If you'd like to help, please do. There's a lot of work to be done.** This guide is currently under heavy development. This opinionated guide exists to provide both novice and expert Python developers a best practice handbook to the installation, configuration, and usage of Python on a daily basis. Topics include: - Platform- and version-specific installations - Py2app, Py2exe, bbfreeze, pyInstaller - Pip - Numpy, scipy, statpy, pyplot, matplotlib - Virtualenv - Fabric - Exhaustive module recommendations, grouped by topic/purpose - Which libraries to use for what - Server configurations & tools for various web frameworks - Documentation: writing it - Testing: Jenkins & tox guides - How to easily interface ``hg`` from ``git`` If you aren't fond of reading reStructuredText, there is an almost up-to-date `HTML version at docs.python-guide.org <http://docs.python-guide.org>`_.