-
Notifications
You must be signed in to change notification settings - Fork 226
Added missing algorithm examples in documentation. #667
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
Conversation
|
@digu-007 I suggest you to have a look at the ongoing review of another example in PR #665 and auto-review your PR addressing the comments posted by @vissarion to the #665, if applicable of coruse. |
|
Looks promising - but they are not called yet. They need to be referred to from source code. |
Referred to from source code means that you need me to add exact header files of the algorithms? |
No need to add extra header files, just inject See for example And you have to inject |
|
Adding images for the geometries in your example will give an extra value on the documentation and help the reader even more. |
Ok sure, working on it. |
Can you please tell me the importance of |
this is code (commented out to not appear in the example) to create the So creating the It is recomened to generate the documentation on your side and test everything is OK. |
I added images and example files to imports.qbk here. Can you please review it. I'm getting bugs while generating the documentation, can you help me with that? |
You need to be (very) specific:
Mind you, crystal spheres are not always handy with their guessing magic. |
I followed Generating-and-Improving-Documentation, and while executing |
|
That Wiki page say:
which I presume you have not attempted. I also think you probably should use the current |
I am using Yes I forgot about I installed Doxygen and QuickBook with the help of this but while running Also can you please verify latest commit. I made the necessary changes to |
You can build documentation from git repo. I'd simply work in the cloned Boost superproject as it is the common way any Boost library is developed.
I suspect you just cloned the You need to clone the whole Boost super-project as it is explained in
First, let's get your documentation build to working state. |
I cloned the whole Boost super-project, switched to develop branch and ran |
|
@digu-007 What shell/console/command line are you familiar with, Windows, Unix or both? Are you familiar with the difference between I suspect you are using Linux. I'd say, it should be quite plain obvious for you to run The Wiki pages try to do its best, present |
I did |
Good, that seems like you've got all headers deployed/symlinked in
That is not strictly necessary. You can just run Try to replicate the commands I run below: $ pwd
/mnt/d/boost.wsl
$ ls
CMakeLists.txt Jamroot README.md b2 boost-build.jam boost.png bootstrap.bat bootstrap.sh doc index.html more rst.css tools
INSTALL LICENSE_1_0.txt appveyor.yml boost boost.css boostcpp.jam bootstrap.log dist index.htm libs project-config.jam status
$ ./b2 headers
Performing configuration checks
- default address-model : 64-bit (cached)
- default architecture : x86 (cached)
- symlinks supported : yes (cached)
...found 1171 targets...
$ ls ./boost
accumulators concept filesystem.hpp
$ cd libs/geometry/
$ ../../b2 test
Performing configuration checks
- default address-model : 64-bit
- default architecture : x86
- symlinks supported : yes
...patience...
...patience...
...patience...
...patience...
...found 11821 targets...
...updating 2757 targets...
...on 100th target...
...on 200th target...
gcc.compile.c++ ../../bin.v2/libs/geometry/test/util/util_math_abs.test/gcc-9/debug/threading-multi/visibility-hidden/math_abs.o
gcc.compile.c++ ../../bin.v2/libs/geometry/test/util/util_math_sqrt.test/gcc-9/debug/threading-multi/visibility-hidden/math_sqrt.o
gcc.compile.c++ ../../bin.v2/libs/geometry/test/util/util_calculation_type.test/gcc-9/debug/threading-multi/visibility-hidden/calculation_type.o
gcc.link ../../bin.v2/libs/geometry/test/util/util_math_abs.test/gcc-9/debug/threading-multi/visibility-hidden/util_math_abs
testing.capture-output ../../bin.v2/libs/geometry/test/util/util_math_abs.test/gcc-9/debug/threading-multi/visibility-hidden/util_math_abs.run
**passed** ../../bin.v2/libs/geometry/test/util/util_math_abs.test/gcc-9/debug/threading-multi/visibility-hidden/util_math_abs.test
...UPDATE: I asked about the problem on the lists and it's likely a problem with using old |
These tests are running for more than two hours in my system, is there any way to up speed the process? |
|
Buy more cores, e.g. 16 or more ;) It's thousands of programs to compile and link. However, just kill it. You don't have to run all those tests for your purpose of docs. You run that command and let a bunch of tests build as verification you have basic setup ready and b2 command works, and you kill it. |
Maybe ;) Yes, b2 works and I guess the setup is ready. I will run the qbk files tomorrow to generate the changes that I made and check for any errors. |
|
Where could I load the html page of an algorithm from, after editing/adding files and running Output of |
Once you have that configuration in place, you will see 4 targets built: $ cd libs/geometry/doc
$ python3 make_qbk.py
...
Performing configuration checks
- default address-model : 64-bit (cached)
- default architecture : x86 (cached)
- symlinks supported : yes (cached)
...patience...
...patience...
...patience...
...found 5085 targets...
...updating 4 targets...
quickbook.quickbook-to-boostbook ../../../bin.v2/libs/geometry/doc/gcc-9/debug/python-2.7/threading-multi/visibility-hidden/geometry.xml
Generating output file: ../../../bin.v2/libs/geometry/doc/gcc-9/debug/python-2.7/threading-multi/visibility-hidden/geometry.xml
xslt-xsltproc ../../../bin.v2/libs/geometry/doc/gcc-9/debug/python-2.7/threading-multi/visibility-hidden/geometry.docbook
xslt-xsltproc-dir html/geometry_HTML.manifest
...updated 4 targets...Finally, load |
|
@mloskot Can you tell me how to add |
Well, have you tried to follow http://www.boost.org/doc/libs/release/doc/html/quickbook/install.html ? In #667 (comment) you said you followed Generating-and-Improving-Documentation. I assume you followed the "Preparation" section too. Am I missing anything?
Yes, because your setup is missing the |
|
@mloskot Yes, I did setup Here have a look: |
|
Then your question "Can you tell me how to add boostbook to user-config.jam" in #667 (comment) is confusing. Anyway, here is mine If you are still not getting the HTML generated, try to clean the stuff: You may see However, important is if you see this lines at the end of the xslt-xsltproc ../../../bin.v2/libs/geometry/doc/gcc-9/debug/python-2.7/threading-multi/visibility-hidden/geometry.docbook
xslt-xsltproc-dir html/geometry_HTML.manifest |
Oh this is the command for
Yes I'm getting that, and So I guess, everything is fine and I will work on final integration of the example codes and respective images to the frontend. |
That This is complex system indeed. |
|
Btw, AFAIR instead of running |
I think it's a bit too optimistic 😄 The Lines 16 to 17 in 5226efc
|
|
@mloskot yes, I should've written "build the prerequisites". ;) |
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.
I am ok for merging (after addressing my minor comment)! Thanks @digu-007
Edit: I didn't build/check the docs on my side, but the code looks ok to me.
| // Boost.Geometry (aka GGL, Generic Geometry Library) | ||
| // QuickBook Example | ||
|
|
||
| // Copyright (c) 2020-2021 Digvijay Janartha, Hamirpur, India. |
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.
we usually only include the running year, so 2020 is enough
mloskot
left a comment
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.
Well done. Extra credits for patience! :)
|
@vissarion I fixed years in all the files. |
|
Thanks for the PR! |
|
@mloskot @vissarion @awulkiew @barendgehrels |
Correct example comment (copy/paste error). Fixes issue introduced in #667
|
FYI, in 53a6ada I committed quick fix for this issue that sneaked in It broke global Boost docs build, so I had to react quick. |


This PR fixes issue #666.
I have added all the files as stated in the issue, with proper outputs and comments.
Kindly, please review.