mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2026-10-12 08:25:01 -05:00
Add new README, adapt setup.py.
This commit is contained in:
1 parent
02fbceb734
commit
bb3506f564
3 files changed
+64
-4
No files matched your search
@@ -0,0 +1,29 @@
|
||||
=================
|
||||
README for Sphinx
|
||||
=================
|
||||
|
||||
Installing
|
||||
==========
|
||||
|
||||
Use ``setup.py``::
|
||||
|
||||
python setup.py build
|
||||
sudo python setup.py install
|
||||
|
||||
|
||||
Reading the docs
|
||||
================
|
||||
|
||||
After installing::
|
||||
|
||||
cd doc
|
||||
sphinx-build.py . .build
|
||||
browser .build/index.html
|
||||
|
||||
Or read them online at <http://sphinx.pocoo.org/>.
|
||||
|
||||
|
||||
Contributing
|
||||
============
|
||||
|
||||
Send wishes, comments, patches, etc. to georg@python.org.
|
||||
Reference in new issue
Block a user