Skip to content

Document support of .readthedocs.yml #2442

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 13, 2016
Merged

Document support of .readthedocs.yml #2442

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/yaml-config.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Read the Docs YAML Config
=========================

Read the Docs now has support for configuring builds with a YAML file.
The file, `readthedocs.yml`, must be in the root directory of your project.
The file, `readthedocs.yml` (or `.readthedocs.yml`), must be in the root directory of your project.

.. warning:: This feature is in a beta state.
Please file an `issue`_ if you find anything wrong.
Expand Down
2 changes: 1 addition & 1 deletion requirements/pip.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ docutils==0.11
Sphinx==1.3.5
Pygments==2.0.2
mkdocs==0.14.0
git+https://github.com/rtfd/readthedocs-build.git@ef2d91962aeb5391f21245d1e3c311e33785649d#egg=readthedocs-build-2.0.6.dev
git+https://github.com/rtfd/readthedocs-build.git@db4ad19df4f432bfbbd56d05964c58b6634356f3#egg=readthedocs-build-2.0.6.dev
django==1.8.3

django-tastypie==0.12.2
Expand Down