IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Add -i option to symlink index.html to the master doc.

Browse Source
This commit is contained in:
Barry Warsaw 2010-04-29 21:08:58 -04:00
parent 67cd78e55c
commit 9cc95adf06
1 changed files with 8 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
sphinx/setup_command.py
View File

@ -71,8 +71,9 @@ class BuildDoc(Command):
('release=', None, 'The full version, including alpha/beta/rc tags'), ('release=', None, 'The full version, including alpha/beta/rc tags'),
('today=', None, 'How to format the current date, used as the ' ('today=', None, 'How to format the current date, used as the '
'replacement for |today|'), 'replacement for |today|'),
('link-index', 'i', 'Link index.html to the master doc'),
] ]
boolean_options = ['fresh-env', 'all-files'] boolean_options = ['fresh-env', 'all-files', 'link-index']
def initialize_options(self): def initialize_options(self):
@ -83,6 +84,7 @@ class BuildDoc(Command):
self.release = '' self.release = ''
self.today = '' self.today = ''
self.config_dir = None self.config_dir = None
self.link_index = False
def _guess_source_dir(self): def _guess_source_dir(self):
for guess in ('doc', 'docs'): for guess in ('doc', 'docs'):
@ -147,3 +149,8 @@ class BuildDoc(Command):
'backslashreplace') 'backslashreplace')
else: else:
raise raise
if self.link_index:
src = app.config.master_doc + app.builder.out_suffix
dst = app.builder.get_outfilename('index')
os.symlink(src, dst)