Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork5.2k
Updated Sphinx configuration instructions#3332
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 think you did something wrong, in the end it should look like this:https://github.com/WouterJ/symfony-docs/blob/travis_integration/conf.py#L34 |
The problem might be that people are not familiar with our use of the ellipses. Thus, you might be tempted to append the whole |
but this tip suggests that you should remove the other extensions. |
Yeah, the tip is not clear enough. It should be rewritten in such that you have to add the Symfony docs related extensions to the list of already configured extensions if they exist. |
On second thoughts yes the tip can be misleading; I'll think about another phraisng |
| @@ -211,6 +211,31 @@ Installing the Sphinx extensions | |||
| # set URL for API links | |||
| api_url = 'http://api.symfony.com/master/%s' | |||
| .. tip:: | |||
| It seems that with newest Sphinx versions you may receive an error such | |||
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.
It seems sounds too unreliable... what aboutWith newest Sphinx versions you may sometimes receive [...]? That, if the errors happen only sometimes.
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.
it doesn't depend on the sphinx version. It depends on whether someone understands our ellipses usage or not.
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.
The note comes from the possibility (based on what we saw at the hack day), that the newest version of Sphinxmay haveextensions = [] instead ofextensions = ['lots of things'] (meaning it's blank in newer versions). That was part of the reason for the confusion.
This PR was merged into the 2.3 branch.Discussion----------[WIP] Travis integration| Q | A| --- | ---| Doc fix? | no| New docs? | no| Applies to | all| Fixed tickets |#2722,#3332##### Todo - [x] Using sparse checkout - [x] Update contributing docs - [ ] Squashing commits - [ ] Activate Travis hook (@fabpot)Commits-------37eb137 Update documentation8dec729 sparse checkoutsb6f693e Added CMFb1d9e62 Revert changes6cad008 Updated travis configc515613 Added .gitignore85b1b02 Try to supress bundle doc warningsf3cb8b1 Fixed submodules71a2ff4 Added needed config filesd312683 Added sphinx files
Closing this now that we've gone a step further and included the build details in the repository itself :). Though, perhaps now we can take a look back at these instructions and update them to use the new build stuff - I don't think we've done that yet. Cheers! |
Well, there's not much left to do besides installing Sphinx and its extensions and running |
@xabbuh - you're right, I don't know why I thought that needed more work. Cheers! |
Hi,
While starting contributing, I ran into an error in Sphinx configuration.
The syntax of the configuration file should be slightly modified, here I propose to add a "tip", for users who may encounter the same issue.