removing the sphinx_build from setup.py, adding how to run the docs into the README
This commit is contained in:
parent
f94397743e
commit
28760bd33b
18
README.rst
18
README.rst
|
@ -11,6 +11,24 @@ Much of the design is precipitated from the expectation that the auth backends
|
|||
for most deployments will actually be shims in front of existing user systems.
|
||||
|
||||
|
||||
-----------
|
||||
Development
|
||||
-----------
|
||||
|
||||
Building the Documentation
|
||||
--------------------------
|
||||
|
||||
The documentation is all generated with Sphinx from within the docs directory.
|
||||
To generate the full set of HTML documentation:
|
||||
|
||||
cd docs
|
||||
make autodoc
|
||||
make html
|
||||
make man
|
||||
|
||||
the results are in the docs/build/html and docs/build/man directories
|
||||
respectively.
|
||||
|
||||
------------
|
||||
The Services
|
||||
------------
|
||||
|
|
26
setup.py
26
setup.py
|
@ -1,30 +1,5 @@
|
|||
import os
|
||||
import subprocess
|
||||
|
||||
from setuptools import setup, find_packages
|
||||
|
||||
# If Sphinx is installed on the box running setup.py,
|
||||
# enable setup.py to build the documentation, otherwise,
|
||||
# just ignore it
|
||||
cmdclass = {}
|
||||
try:
|
||||
from sphinx.setup_command import BuildDoc
|
||||
|
||||
class local_BuildDoc(BuildDoc):
|
||||
def run(self):
|
||||
base_dir = os.path.dirname(os.path.abspath(__file__))
|
||||
subprocess.Popen(["python", "generate_autodoc_index.py"],
|
||||
cwd=os.path.join(base_dir, "docs")).communicate()
|
||||
for builder in ['html', 'man']:
|
||||
self.builder = builder
|
||||
self.finalize_options()
|
||||
BuildDoc.run(self)
|
||||
cmdclass['build_sphinx'] = local_BuildDoc
|
||||
except:
|
||||
# unable to import sphinx, politely skip past...
|
||||
pass
|
||||
|
||||
|
||||
setup(name='keystone',
|
||||
version='2012.1',
|
||||
description="Authentication service for OpenStack",
|
||||
|
@ -35,6 +10,5 @@ setup(name='keystone',
|
|||
packages=find_packages(exclude=['test', 'bin']),
|
||||
scripts=['bin/keystone', 'bin/keystone-manage'],
|
||||
zip_safe=False,
|
||||
cmdclass=cmdclass,
|
||||
install_requires=['setuptools'],
|
||||
)
|
||||
|
|
Loading…
Reference in New Issue