Merge pull request #17 from skirpichev/dotreadthedocs.yml

Support .readthedocs.yml (optionally)

Author: ericholscher

README.rst

@@ -24,8 +24,8 @@ Running a build is simple::
 
     rtd-build
 
-This will search for all ``readthedocs.yml`` files below your current directory
-and will build your documentation.
+This will search for all ``readthedocs.yml`` (or ``.readthedocs.yml``) files
+below your current directory and will build your documentation.
 
 You can set a specific a directory where the built documentation should be
 stored::

readthedocs_build/config/config.py

@@ -17,7 +17,7 @@
     'load', 'BuildConfig', 'ConfigError', 'InvalidConfig', 'ProjectConfig')
 
 
-CONFIG_FILENAME = 'readthedocs.yml'
+CONFIG_FILENAMES = ('readthedocs.yml', '.readthedocs.yml')
 
 
 BASE_INVALID = 'base-invalid'
@@ -346,11 +346,14 @@ def load(path, env_config):
     The config will be validated.
     """
 
-    config_files = list(find_all(path, CONFIG_FILENAME))
+    config_files = list(find_all(path, CONFIG_FILENAMES))
     if not config_files:
-        raise ConfigError(
-            'No {filename} found'.format(filename=CONFIG_FILENAME),
-            code=CONFIG_REQUIRED)
+        files = '{}'.format(', '.join(map(repr, CONFIG_FILENAMES[:-1])))
+        if files:
+            files += ' or '
+        files += '{!r}'.format(CONFIG_FILENAMES[-1])
+        raise ConfigError('No files {} found'.format(files),
+                          code=CONFIG_REQUIRED)
     build_configs = []
     for filename in config_files:
         with open(filename, 'r') as file:

readthedocs_build/config/find.py

@@ -1,8 +1,9 @@
 import os
 
 
-def find_all(path, filename):
+def find_all(path, filenames):
     path = os.path.abspath(path)
     for root, dirs, files in os.walk(path):
-        if filename in files:
-            yield os.path.abspath(os.path.join(root, filename))
+        for filename in filenames:
+            if filename in files:
+                yield os.path.abspath(os.path.join(root, filename))

readthedocs_build/config/test_find.py

@@ -6,15 +6,15 @@
 
 def test_find_no_files(tmpdir):
     with tmpdir.as_cwd():
-        paths = list(find_all(os.getcwd(), 'readthedocs.yml'))
+        paths = list(find_all(os.getcwd(), ('readthedocs.yml',)))
     assert len(paths) == 0
 
 
 def test_find_at_root(tmpdir):
     apply_fs(tmpdir, {'readthedocs.yml': '', 'otherfile.txt': ''})
 
     base = str(tmpdir)
-    paths = list(find_all(base, 'readthedocs.yml'))
+    paths = list(find_all(base, ('readthedocs.yml',)))
     assert paths == [
         os.path.abspath(os.path.join(base, 'readthedocs.yml'))
     ]
@@ -36,8 +36,42 @@ def test_find_nested(tmpdir):
     apply_fs(tmpdir, {'first/readthedocs.yml': ''})
 
     base = str(tmpdir)
-    paths = list(find_all(base, 'readthedocs.yml'))
+    paths = list(find_all(base, ('readthedocs.yml',)))
     assert set(paths) == set([
         str(tmpdir.join('first', 'readthedocs.yml')),
         str(tmpdir.join('third', 'readthedocs.yml')),
     ])
+
+
+def test_find_multiple_files(tmpdir):
+    apply_fs(tmpdir, {
+        'first': {
+            'readthedocs.yml': '',
+            '.readthedocs.yml': 'content',
+        },
+        'second': {
+            'confuser.txt': 'content',
+        },
+        'third': {
+            'readthedocs.yml': 'content',
+            'Makefile': '',
+        },
+    })
+    apply_fs(tmpdir, {'first/readthedocs.yml': ''})
+
+    base = str(tmpdir)
+    paths = list(find_all(base, ('readthedocs.yml',
+                                 '.readthedocs.yml')))
+    assert paths == [
+        str(tmpdir.join('first', 'readthedocs.yml')),
+        str(tmpdir.join('first', '.readthedocs.yml')),
+        str(tmpdir.join('third', 'readthedocs.yml')),
+    ]
+
+    paths = list(find_all(base, ('.readthedocs.yml',
+                                 'readthedocs.yml')))
+    assert paths == [
+        str(tmpdir.join('first', '.readthedocs.yml')),
+        str(tmpdir.join('first', 'readthedocs.yml')),
+        str(tmpdir.join('third', 'readthedocs.yml')),
+    ]