diff --git a/.gitattributes b/.gitattributes index 040cc07f44..920aef3441 100644 --- a/.gitattributes +++ b/.gitattributes @@ -1,4 +1,4 @@ .* export-ignore *.md export-ignore -Tests/* export-ignore -Resources/doc/* export-ignore +tests/* export-ignore +docs/* export-ignore diff --git a/.travis/install_docs.sh b/.travis/install_docs.sh index 362f6449ff..a5522d971c 100755 --- a/.travis/install_docs.sh +++ b/.travis/install_docs.sh @@ -1,4 +1,4 @@ #!/usr/bin/env sh set -ev -pip install -r Resources/doc/requirements.txt --user +pip install -r docs/requirements.txt --user diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d57776f4a3..affb2ef472 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -74,13 +74,13 @@ php-cs-fixer fix --verbose #### The documentation -The documentation is mostly written with the `rst` format, and can be found in the `Resources/doc` directory. +The documentation is mostly written with the `rst` format, and can be found in the `docs` directory. You can test the doc rendering with the `make docs` command, but to do this, you will need [Sphinx][sphinx_install]. Just like php dependencies can be managed with Composer, python dependencies can be managed with [pip][pip_install]. To get sphinx, simply run the following command. ```bash -pip install --requirement Resources/doc/requirements.txt --user +pip install --requirement docs/requirements.txt --user ``` Some python binaries should be downloaded to `~/.local/bin` for Linux or `~/Library/Python/2.7/bin` for Mac OS, @@ -90,7 +90,7 @@ so that it contains this path and then, from the root of the project, run `make If `make docs` is successful, you should be able to see your modifications: ```bash -$YOUR_FAVORITE_BROWSER Resources/doc/_build/html/index.html +$YOUR_FAVORITE_BROWSER docs/_build/html/index.html ``` If your PR contains a new feature, you must add documentation for it. diff --git a/Makefile b/Makefile index e27d3cd38b..43e65b4e7d 100644 --- a/Makefile +++ b/Makefile @@ -19,4 +19,4 @@ test: phpunit -c phpunit.xml.dist --coverage-clover build/logs/clover.xml docs: - cd Resources/doc && sphinx-build -W -b html -d _build/doctrees . _build/html + cd docs && sphinx-build -W -b html -d _build/doctrees . _build/html