Skip to content

Commit f0443b4

Browse files
committed
Merge pull request #1597 from rtfd/dont-support-readme-copy
Delete logic that copies README.
2 parents 1c1b2ab + 5385f2f commit f0443b4

File tree

3 files changed

+11
-8
lines changed

3 files changed

+11
-8
lines changed

readthedocs/doc_builder/backends/sphinx.py

+4-3
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ def __init__(self, *args, **kwargs):
4343
docs_dir = self.docs_dir()
4444
self.old_artifact_path = os.path.join(docs_dir, self.sphinx_build_dir)
4545

46-
def _write_config(self):
46+
def _write_config(self, master_doc='index'):
4747
"""
4848
Create ``conf.py`` if it doesn't exist.
4949
"""
@@ -52,6 +52,7 @@ def _write_config(self):
5252
{'project': self.project,
5353
'version': self.version,
5454
'template_dir': TEMPLATE_DIR,
55+
'master_doc': master_doc,
5556
})
5657
conf_file = os.path.join(docs_dir, 'conf.py')
5758
safe_write(conf_file, conf_template)
@@ -64,8 +65,8 @@ def append_conf(self, **kwargs):
6465
try:
6566
conf_py_path = self.version.get_conf_py_path()
6667
except ProjectImportError:
67-
self._write_config()
68-
self.create_index(extension='rst')
68+
master_doc = self.create_index(extension='rst')
69+
self._write_config(master_doc=master_doc)
6970

7071
project = self.project
7172
# Open file for appending.

readthedocs/doc_builder/base.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -98,8 +98,7 @@ def create_index(self, extension='md', **kwargs):
9898
if not os.path.exists(index_filename):
9999
readme_filename = os.path.join(docs_dir, 'README.{ext}'.format(ext=extension))
100100
if os.path.exists(readme_filename):
101-
os.system('mv {readme} {index}'.format(index=index_filename,
102-
readme=readme_filename))
101+
return 'README'
103102
else:
104103
index_file = open(index_filename, 'w+')
105104
index_text = """
@@ -116,6 +115,7 @@ def create_index(self, extension='md', **kwargs):
116115

117116
index_file.write(index_text.format(dir=docs_dir, ext=extension))
118117
index_file.close()
118+
return 'index'
119119

120120
def run(self, *args, **kwargs):
121121
'''Proxy run to build environment'''

readthedocs/templates/sphinx/conf.py.conf

+5-3
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,19 @@
11
# -*- coding: utf-8 -*-
22

3+
# This is the conf.py file that we create automatically for projects.
4+
# It will still get the RTD logic appended to it.
5+
36
import sys, os
47
extensions = []
5-
templates_path = ['{{ template_dir }}', 'templates', '_templates', '.templates']
8+
templates_path = ['{{ template_dir }}']
69
source_suffix = '{{ project.suffix }}'
7-
master_doc = 'index'
10+
master_doc = '{{ master_doc }}'
811
project = u'{{ project.name }}'
912
copyright = u'{{ project.copyright }}'
1013
version = '{{ version.verbose_name }}'
1114
release = '{{ version.verbose_name }}'
1215
exclude_patterns = ['_build']
1316
pygments_style = 'sphinx'
14-
htmlhelp_basename = '{{ project.slug }}'
1517
file_insertion_enabled = False
1618
latex_documents = [
1719
('index', '{{ project.slug }}.tex', u'{{ project.name }} Documentation',

0 commit comments

Comments
 (0)