-
Notifications
You must be signed in to change notification settings - Fork 116
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 our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Rewrite doc using RestructuredText #213
Conversation
f8e0274
to
1346916
Compare
@javiereguiluz let me know what do you think. I have build it with sphinx and all is well. |
@egeloen thanks for updating the format of your documentation. 95% of your doc is right, but there were some syntax issues. These were mostly related to long lines, so instead of adding comments to this pull request, I've created a new one in #214. The new pull request has been created against the Thanks again for transforming all the documentation! |
Thanks as well for your PR! Can you ealoborate about the line length? I have not seen somethink like that in the "Symfony doc" documentation. Is it somethink related to Sphinx or it is only for consistency? |
The line length limit and other specific format rules are defined in this doc: http://symfony.com/doc/current/contributing/documentation/standards.html This limit is not because of Sphinx but because we think this makes the doc more readable in any format and situation (if you read the raw documentation, short lines make it look well). |
Sorry, I was searching the Anyway, thanks for the explanation, let's follow this rule :) |
|
||
.. code-block:: php | ||
|
||
$builder->add('field', 'ckeditor', array('auto_inline' => false)); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
as these 2 examples are showing different things (config vs widget), I recommend to use 2 seperate code blocks/examples. the tabbed code blocks (configuration block) is often used to show the same feature in different formats.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done
@javiereguiluz I see you remove some |
@egeloen yes. This is because Symfony uses a trick to highlight PHP code without creating a very verbose documentation. I don't agree with this trick (I think it's an ugly and dangerous hack) but it's used everywhere in the Symfony docs, so it's "the official way of doing things". The trick is to remove
|
Rewrite doc using RestructuredText
This PR fixes #210 and is related to symfony/symfony-docs#6248