Skip to content

Commit bf73f40

Browse files
Don't move README to index on check if there exists an index file
Related #1550.
1 parent f70e4a5 commit bf73f40

File tree

1 file changed

+13
-14
lines changed

1 file changed

+13
-14
lines changed

readthedocs/doc_builder/base.py

+13-14
Original file line numberDiff line numberDiff line change
@@ -93,16 +93,14 @@ def create_index(self, extension='md', **kwargs):
9393
"""
9494

9595
docs_dir = self.docs_dir()
96-
97-
index_filename = os.path.join(docs_dir, 'index.{ext}'.format(ext=extension))
98-
if not os.path.exists(index_filename):
99-
readme_filename = os.path.join(docs_dir, 'README.{ext}'.format(ext=extension))
100-
if os.path.exists(readme_filename):
101-
os.system('mv {readme} {index}'.format(index=index_filename,
102-
readme=readme_filename))
103-
else:
104-
index_file = open(index_filename, 'w+')
105-
index_text = """
96+
valid_filenames = ('index', 'README')
97+
index_filenames = [
98+
os.path.join(docs_dir, '{filename}.{ext}'.format(
99+
filename=filename, ext=extension))
100+
for filename in valid_filenames]
101+
if not any(os.path.exists(filename) for filename in index_filenames):
102+
primary_index = index_filenames[0]
103+
index_text = """
106104
107105
Welcome to Read the Docs
108106
------------------------
@@ -112,10 +110,11 @@ def create_index(self, extension='md', **kwargs):
112110
Please create a ``{dir}/index.{ext}`` or ``{dir}/README.{ext}`` file with your own content.
113111
114112
If you want to use another markup, choose a different builder in your settings.
115-
"""
116-
117-
index_file.write(index_text.format(dir=docs_dir, ext=extension))
118-
index_file.close()
113+
"""
114+
with open(primary_index, 'w+') as index_file:
115+
index_file.write(index_text.format(
116+
dir=docs_dir,
117+
ext=extension))
119118

120119
def run(self, *args, **kwargs):
121120
'''Proxy run to build environment'''

0 commit comments

Comments
 (0)