@@ -72,9 +72,29 @@ php-cs-fixer fix --verbose
7272
7373#### The documentation
7474
75- The documentation is mostly written with the ` rst ` format. You can test the doc rendering with the ` make docs ` command.
75+ The documentation is mostly written with the ` rst ` format, and can be found in the ` Resources/doc ` directory.
76+ You can test the doc rendering with the ` make docs ` command, but to do this, you will need [ Sphinx] [ sphinx_install ] .
77+ Just like php dependencies can be managed with Composer, python dependencies can be managed with [ pip] [ pip_install ] .
78+ To get sphinx, simply run the following command.
79+
80+ ``` bash
81+ pip install --requirement Resources/doc/requirements.txt --user
82+ ```
83+
84+ Some python binaries should be downloaded in ` ~/.local/bin ` ,
85+ [ modify your ` $PATH ` environment variable] ( http://www.linfo.org/path_env_var.html )
86+ so that it contains this path and then, from the root of the project, run ` make docs `
87+
88+ If ` make docs ` is successful, you should be able to see your modifications:
89+
90+ ``` bash
91+ $YOUR_FAVORITE_BROWSER Resources/doc/_build/html/index.html
92+ ```
7693
7794If your PR contains a new feature, you must add documentation for it.
95+ Of course, you can also create PRs consisting only in documentation changes.
96+
97+ Documentation contributions should comply with [ the Symfony documentation standards] [ sf_docs_standards ] .
7898
7999#### The tests
80100
@@ -317,3 +337,7 @@ This is a consensus made on #4242 in addition to #1337.
317337We agreed that blank color is boring and so deja vu. Pink is the new way to do.
318338```
319339(Obviously, this commit is fake. :wink : )
340+
341+ [ sphinx_install ] : http://www.sphinx-doc.org/en/stable/
342+ [ pip_install ] : https://pip.pypa.io/en/stable/installing/
343+ [ sf_docs_standards ] : https://symfony.com/doc/current/contributing/documentation/standards.html
0 commit comments