Skip to content

Commit 3e464e2

Browse files
committed
Rename environment file
1 parent 0fba168 commit 3e464e2

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

readthedocs/doc_builder/python_environments.py

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -99,21 +99,21 @@ def venv_bin(self, filename=None):
9999
return os.path.join(*parts)
100100

101101
def environment_json_path(self):
102-
"""Return the path to the ``environment.json`` file for this venv."""
102+
"""Return the path to the ``readthedocs-environment.json`` file."""
103103
return os.path.join(
104104
self.venv_path(),
105-
'environment.json',
105+
'readthedocs-environment.json',
106106
)
107107

108108
@property
109109
def is_obsolete(self):
110110
"""
111111
Determine if the Python version of the venv obsolete.
112112
113-
It checks the the data stored at ``environment.json`` and compares it
114-
against the Python version in the project version to be built and the
115-
Docker image used to create the venv against the one in the project
116-
version config.
113+
It checks the the data stored at ``readthedocs-environment.json`` and
114+
compares it against the Python version in the project version to be
115+
built and the Docker image used to create the venv against the one in
116+
the project version config.
117117
118118
:returns: ``True`` when it's obsolete and ``False`` otherwise
119119
@@ -131,7 +131,7 @@ def is_obsolete(self):
131131
env_python_version = environment_conf['python']['version']
132132
env_build_image = environment_conf['build']['image']
133133
except (IOError, TypeError, KeyError, ValueError):
134-
log.error('Unable to read/parse environment.json file')
134+
log.error('Unable to read/parse readthedocs-environment.json file')
135135
return False
136136

137137
# TODO: remove getattr when https://github.com/rtfd/readthedocs.org/pull/3339 got merged

0 commit comments

Comments
 (0)