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

Audit the intra-doc links to find breakage #112

Closed
tzlaine opened this issue Feb 23, 2024 · 1 comment
Closed

Audit the intra-doc links to find breakage #112

tzlaine opened this issue Feb 23, 2024 · 1 comment

Comments

@tzlaine
Copy link
Owner

tzlaine commented Feb 23, 2024

There were a bunch of broken links reported in the Boost review. They were all _foo() functions (e.g. _val()). Each of these ends up in its own Doxygen-generated file, like parser/doc/html/boost/parser/_val.html. Problem is, the Github Pages publishing software won't process those files, because of the leading underscore. So this should have no impact on the final docs on the Boost website. I claim victory. Also, while auditing all the links, I did find a real broken one, to the "Expectation points" section. So that still needs fixing.

@tzlaine
Copy link
Owner Author

tzlaine commented Feb 24, 2024

Ok, so apparently you can add an empty file called .nojekyll to the root of the gh-pages branch, and it fixes the leading-underscore issue. So, I did that too.

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

No branches or pull requests

1 participant