Skip to content
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

Fixed doc errors reported by docs build tool #690

Merged
merged 2 commits into from
Jan 9, 2016
Merged

Fixed doc errors reported by docs build tool #690

merged 2 commits into from
Jan 9, 2016

Conversation

javiereguiluz
Copy link
Contributor

We recently reenabled the "docs build error reporting" on symfony.com and these are the errors shows for this bundle:

var/docs/rst/liip-liipimagine-bundle/en/master/configuration.rst:60: ERROR: Unexpected indentation.
var/docs/rst/liip-liipimagine-bundle/en/master/configuration.rst:61: WARNING: Block quote ends without a blank line; unexpected unindent.
var/docs/rst/liip-liipimagine-bundle/en/master/filters.rst:8: WARNING: Title underline too short.
var/docs/rst/liip-liipimagine-bundle/en/master/cache-manager.rst:: WARNING: document isn't included in any toctree
var/docs/rst/liip-liipimagine-bundle/en/master/cache-resolver/amazons3.rst:: WARNING: document isn't included in any toctree
var/docs/rst/liip-liipimagine-bundle/en/master/cache-resolver/aws_s3.rst:: WARNING: document isn't included in any toctree
var/docs/rst/liip-liipimagine-bundle/en/master/cache-resolver/cache.rst:: WARNING: document isn't included in any toctree
var/docs/rst/liip-liipimagine-bundle/en/master/cache-resolver/proxy.rst:: WARNING: document isn't included in any toctree
var/docs/rst/liip-liipimagine-bundle/en/master/cache-resolver/web_path.rst:: WARNING: document isn't included in any toctree
var/docs/rst/liip-liipimagine-bundle/en/master/cache-resolvers.rst:: WARNING: document isn't included in any toctree
var/docs/rst/liip-liipimagine-bundle/en/master/configuration.rst:: WARNING: document isn't included in any toctree
var/docs/rst/liip-liipimagine-bundle/en/master/data-loader/filesystem.rst:: WARNING: document isn't included in any toctree
var/docs/rst/liip-liipimagine-bundle/en/master/data-loader/gridfs.rst:: WARNING: document isn't included in any toctree
var/docs/rst/liip-liipimagine-bundle/en/master/data-loader/stream.rst:: WARNING: document isn't included in any toctree
var/docs/rst/liip-liipimagine-bundle/en/master/data-loaders.rst:: WARNING: document isn't included in any toctree
var/docs/rst/liip-liipimagine-bundle/en/master/filters.rst:: WARNING: document isn't included in any toctree
var/docs/rst/liip-liipimagine-bundle/en/master/installation.rst:: WARNING: document isn't included in any toctree
var/docs/rst/liip-liipimagine-bundle/en/master/introduction.rst:: WARNING: document isn't included in any toctree

In this PR I'm trying to fix all of them. Before merging, I'd like to ask to our RST experts (@xabbuh and @wouterj) if they agree with the changes related to .. toctree. Thanks!

@javiereguiluz javiereguiluz mentioned this pull request Jan 8, 2016
@lsmith77 lsmith77 added the State: Reviewing This item is being reviewed to determine if it should be accepted. label Jan 9, 2016
lsmith77 added a commit that referenced this pull request Jan 9, 2016
Fixed doc errors reported by docs build tool
@lsmith77 lsmith77 merged commit bf3f931 into liip:master Jan 9, 2016
@lsmith77 lsmith77 removed the State: Reviewing This item is being reviewed to determine if it should be accepted. label Jan 9, 2016
@wouterj
Copy link

wouterj commented Jan 9, 2016

Nothing wrong with toctree btw :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants