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

Bad references should be reported instead of being ignored silently #96

Open
jwage opened this issue Apr 12, 2018 · 4 comments
Open

Bad references should be reported instead of being ignored silently #96

jwage opened this issue Apr 12, 2018 · 4 comments
Labels
Enhancement New feature or request

Comments

@jwage
Copy link
Member

jwage commented Apr 12, 2018

Right now if some docs have a reference to a page that doesn't exist, it just silently ignores it and leaves an empty href.

@jwage jwage added the Enhancement New feature or request label Apr 13, 2018
@SenseException
Copy link
Member

With the usage of doctrine/rst-parser #233, unknown references result in an unknown anchor now. How should the reporting look like? Should there be an output in the console?

@jwage
Copy link
Member Author

jwage commented Sep 11, 2018

It silently ignores the bad reference right now and outputs the unknown reference link in the HTML. @weaverryan and I have talked about adding a feature to doctrine/rst-parser that would let you throw an exception if a bad reference is encountered.

@SenseException
Copy link
Member

That would be the (unresolved) case. So the plan is to make the build of the docs fail on a unresolvable reference?

@jwage
Copy link
Member Author

jwage commented Sep 12, 2018

Yes. That is my current thought.

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

No branches or pull requests

2 participants