-
Notifications
You must be signed in to change notification settings - Fork 1.7k
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
doc/html/boostbook.html
redirects to itself
#937
Comments
In terms of boostbook related files, if everything was reverted to boost 1.85.0, it should presumably work again. After any updates observe the results of the snapshot: https://www.boost.org/doc/libs/develop/doc/html/boostbook.html |
I don't want to revert back to 1.85 state. The issue needs to be fixed at its root. |
Sure. Keep this in mind though: in previous versions of the boost superproject |
Thing is, I cannot find where Now, regarding the dummy |
@Kojoley Could you have a look, please? In particular, is this line: Line 201 in f400245
supposed to invoke the build of html documentation in Other than this line, I cannot see where |
Earlier you pointed out a change in the superproject: That removed "boostbook.xml". "boostbook.xml" contains the content of the generated pages. Reverting the commit ought to fix it, right? Go back to referencing that file again. But then... your reply is that solution is not optimal. Or not the root of the problem. Ok. |
It doesn't. That is, it doesn't result in |
It's been a while since I had touched docs stuff really, I don't even remember how to build release docs. Could you point me to a starting point? I suspect the culprit is missing Looking at https://github.com/boostorg/boost/blame/master/doc/Jamfile.v2 history the docs building stuff seems to had been implemented by @grafikrobot so he might help untangle this? |
The b2 command is in a release python script. Here's where in CI is executes it: https://app.circleci.com/pipelines/github/boostorg/boost/12704/workflows/8e3c6e40-a1f5-48d3-8f34-3e3858e74dce/jobs/27422?invite=true#step-108-11803_107
The doc/jamfile deals with it by only building the targets that exist for each library.
I could try.. Although if it used to work and doesn't now not sure why that would be. |
So if a library misses documentation it doesn't care? That's not good...
There was a change 2403dac, we fixed one thing and seems to have broken other. |
Thanks for the idea. Those targets were never there. I've added them and in my local build with (BTW, in my local build, However, even though |
The documentation is built at tools/boostbook/doc/html, and tools/boostbook/index.html contains a universal redirect to the actual location of the docs entry point. This also resolves the circular redirect in doc/html/boostbook.html. Refs boostorg#937.
Try this:
or
|
I think this will include BoostBook in the unified Boost documentation twice here - first by including BoostBook in My current |
Then every library is already included twice and it looks like it was intended, in Lines 194 to 203 in 30c8b45
Lines 210 to 214 in 30c8b45
|
The documentation is built at tools/boostbook/doc/html, and tools/boostbook/index.html contains a universal redirect to the actual location of the docs entry point. This also resolves the circular redirect in doc/html/boostbook.html. Refs #937.
The documentation is built at tools/boostbook/doc/html, and tools/boostbook/index.html contains a universal redirect to the actual location of the docs entry point. This also resolves the circular redirect in doc/html/boostbook.html. Refs #937.
This is related to boostorg/boostbook#29.
The
doc/html/boostbook.html
file on both develop and master redirects to http://www.boost.org/doc/libs/master/doc/html/boostbook.html, which is the same file on master. In other words, this file performs infinite redirection to itself.I'm not sure if this file is supposed to be overwritten on the website, but I didn't find anything to that effect in the superproject docs build scripts and release-tools. If it is supposed to somehow work, please let me know how.
If this file is not used then it should probably be removed. Otherwise, if it is supposed to redirect to BoostBook docs, then it should redirect to either
tools/boostbook/index.html
ortools/boostbook/doc/html/index.html
(preferably, the former).Note that
tools/boostbook/index.html
was previously redirecting to../../doc/html/boostbook.html
(i.e. the problematic file in the superproject), and this was changed todoc/html/index.html
(i.e. the correct file of the generated BoostBook docs intools/boostbook
).Additionally, there is
tools/index.html
that has a link todoc/html/boostbook.html
. This file needs to be updated ifdoc/html/boostbook.html
is removed.The text was updated successfully, but these errors were encountered: