Skip to content

Commit

Permalink
DevKit updates (#4760)
Browse files Browse the repository at this point in the history
  • Loading branch information
SonataCI committed Nov 15, 2017
1 parent 24938c9 commit cb43262
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 7 deletions.
4 changes: 2 additions & 2 deletions .gitattributes
@@ -1,4 +1,4 @@
.* export-ignore
*.md export-ignore
Tests/* export-ignore
Resources/doc/* export-ignore
tests/* export-ignore
docs/* export-ignore
2 changes: 1 addition & 1 deletion .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
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Expand Up @@ -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,
Expand All @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion Makefile
Expand Up @@ -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

0 comments on commit cb43262

Please sign in to comment.