Skip to content

[WIP] The Testing Documentation section is unclear. #3917

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

Closed
wants to merge 1 commit into from
Closed

[WIP] The Testing Documentation section is unclear. #3917

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
The Testing Documentation section is unclear. 
I installed `Sphinx` then did the `git submodules` next generated the docs thus skipping the `bash install.sh`

```
* Install `Sphinx`_;
* Install the Sphinx extensions using git submodules: ``git submodule update --init``;
* (Optionally) Install the bundle docs and CMF docs: ``bash install.sh``;
* Run ``make html`` and view the generated HTML in the ``build`` directory.
```

It is unclear what to expect after each step.

Opening ie `$ open _build/html/cookbook/controller/error_pages.html` it does not look at all similar to http://symfony.com/doc/current/cookbook/controller/error_pages.html

So I ran `bash install.sh` expecting that should do it. Nope.

I would propose the following changes:

- [ ] Add text about test sphinx is already installed.
- [ ] We should explain how the build will look like.
- [ ] We should explain why `bash install.sh` is optional.
- [ ] Tell about the additional _ext directory and how not to add it to the PR.
  • Loading branch information
@clemens-tolboom
clemens-tolboom committed Jun 8, 2014
commit 311b90c42d74eee81508e8fe6546746b40dc3164
2 changes: 1 addition & 1 deletion contributing/documentation/format.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,7 @@ Testing Documentation

To test documentation before a commit:

* Install `Sphinx`_;
* Check for sphinx : ``sphinx-build --version``. If not available install `Sphinx`_;
* Install the Sphinx extensions using git submodules: ``git submodule update --init``;
* (Optionally) Install the bundle docs and CMF docs: ``bash install.sh``;
* Run ``make html`` and view the generated HTML in the ``build`` directory.
Expand Down