Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork5.2k
[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.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Uh oh!
There was an error while loading.Please reload this page.
Conversation
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 tohttp://symfony.com/doc/current/cookbook/controller/error_pages.htmlSo 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.
Symfony uses a custom Symfony theme, you'll get the default Sphinx theme. That's why it's different.
If everything is correct, the gitignore should ignore this _exts directory:https://github.com/symfony/symfony-docs/blob/master/.gitignore#L8 I don't think we should put much time into this. We are working hard to facilitate a demo for each PR automatically (in the same way as Travis currently works here). When we do that, we no longer need any of this. |
I disagree with
as it explains how the proces works thus learning something new. /me developer |
@javiereguiluz can you maybe include these suggestions to your PR about revamping the contributing guide? Thanks! |
Pff, I'm happy to have you around, I can't keep track of everything... :p In that case, we have to update this PR.@clemens-tolboom do you have any suggestions? |
#4223 does not address this PR. So it still stands. Not sure I find the time as this issue came to life due to other doc PRs. I know what to expect next time. But it may help others. |
I'm going to close this PR as it doesn't add that much information at the moment and you said you didn't know if you had any time to update this PR. I've created an issue with the tasks you mentioned in the start post of this PR:#5259 (please note that some are no longer relevant). Thanks for bringing this up! |
Thanks for the update |
I installed
Sphinxthen did thegit submodulesnext generated the docs thus skipping thebash install.shIt is unclear what to expect after each step.
Opening ie
$ open _build/html/cookbook/controller/error_pages.htmlit does not look at all similar tohttp://symfony.com/doc/current/cookbook/controller/error_pages.htmlSo I ran
bash install.shexpecting that should do it. Nope.I would propose the following changes:
bash install.shis optional.