84 Commits

Author SHA1 Message Date
Barend Gehrels
218bc0631e feat: enhance and fix documentation 2024-09-27 17:52:26 +02:00
Andrey Semashev
e922b89e36 Fix doxygen_xml2qbk execution from make_qbk.py.
When b2 invokes doc/make_qbk.py, it passes a relative path to the compiled
doxygen_xml2qbk executable. This path becomes invalid if used from a directory
different from doc, which may happen as make_qbk.py changes the current
directory during its execution. Additionally, doc/index/make_qbk.py invokes
doxygen_xml2qbk unqualified, which requires the executable to be in PATH and
is never the case unless the user has pre-compiled and placed it accordingly.

To fix this, first resolve the paths to doxygen and doxygen_xml2qbk to absolute
paths before changing the current directory. Additionally, pass the resolved
path to doxygen_xml2qbk to doc/index/make_qbk.py via the DOXYGEN_XML2QBK
environment variable.

Fixes https://github.com/boostorg/geometry/issues/1311.
2024-09-25 02:37:00 +03:00
Vissarion Fisikopoulos
09c5132e84 [closest_points] Add documentation and examples 2021-11-18 11:15:48 +02:00
Adam Wulkiewicz
1c9e1933b4 [doc][convex_hull] Fix documentation of convex_hull algorithm. 2021-03-26 02:24:43 +01:00
Adam Wulkiewicz
c267547e2e [doc] Add documentation for azimuth() algorithm. 2021-01-20 02:49:40 +01:00
Aditya Mohan
a4f08ea191
Add cross_product example to documentation (#665)
* Cross_Product Example

* Update cross_product

- Removes the first empty line
- Uses doxygen commands
- Adds result at the end as comments
- Mentions that the second point is undefined in Example 1

* Update Cross_Product

- Added a missing `

* Update imports.qbk

- Adds [import src/examples/arithmetic/cross_product.cpp]

* Create cross_product.qbk

* Update cross_product.hpp

Refers cross_product example

* Delete cross_product.qbk

Uneccessary

* Update

Deletes .qbk reference

* Update make_qbk.py

* Rename cross_product to cross_product.cpp

* Update

-Shifts example reference to line 115-116

Co-authored-by: Vissarion Fisikopoulos <fisikop@gmail.com>
2020-03-16 15:43:25 +02:00
Mateusz Łoskot
64de5b9edf
Add point_xyz as pre-defined geometry model (#671)
Add documentation, example and test for point_xyz.
2020-03-04 23:18:16 +01:00
Vissarion Fisikopoulos
1c0f3e398a
Merge branch 'develop' into feature/line_interpolate_point_2 2019-02-27 15:13:37 +02:00
Barend Gehrels
f685f8ab9a
Merge branch 'develop' into feature/buffer_point_geographic 2019-02-23 14:01:18 +01:00
Vissarion Fysikopoulos
83976015e8 [doc] Fix and error in documentation building 2019-02-19 16:51:00 +02:00
Vissarion Fysikopoulos
03036b4b62 [algorithm] [strategy] [test] [doc] Rename line_interpolate_point to line_interpolate 2019-02-19 16:32:22 +02:00
Barend Gehrels
c46e4625a7 [buffer] rename strategy (review result) 2019-02-13 11:44:13 +01:00
Barend Gehrels
6ea11b3f58 [doc] Add documentation for new point_circle_geographic strategy 2019-01-16 11:55:56 +01:00
Vissarion Fysikopoulos
d553d82d56 Resolve conflicts and merge with develop 2018-12-17 14:02:20 +02:00
Vissarion Fysikopoulos
a5b5441715 [doc] Fix ordering in imports.qbk and make_qbk.py 2018-11-30 14:36:43 +02:00
Adam Wulkiewicz
18ee92853e [io][doc] Add documentation for DSV stream output. 2018-11-29 02:20:01 +01:00
Vissarion Fysikopoulos
87dfbe07a8 [doc] Line interpolate point algorithm and strategies 2018-10-26 17:03:24 +03:00
Vissarion Fysikopoulos
b6d68bc339 [doc] Support python3 in building documentation 2018-10-24 12:02:44 +03:00
Yaghyavardhan singh khangarot
b27c81f316 [doc][similarity] Added Strategies in the documentation 2018-08-14 16:36:29 +05:30
Yaghyavardhan singh khangarot
81634c2ccb [doc][similarity] Added Strategies in the documentation 2018-08-14 16:33:49 +05:30
Yaghyavardhan singh khangarot
50ca27ebb9 [doc][similarity] Updated documentation for the similarity algorithms 2018-08-12 05:07:16 +05:30
Yaghyavardhan singh khangarot
fc0f5525ae [doc][similarity] Add documentation for algorithm for finding similarity between geometries 2018-08-06 05:41:12 +05:30
Yaghyavardhan singh khangarot
0591e109ce [doc][similarity] add documentation for discrete_frechet_disatance and discrete_hausdorff_distance. 2018-08-02 19:52:40 +05:30
Adam Wulkiewicz
2a2e0ac41e [doc][srs][strategies] Add/improve docs of geographic strategies and spheroid. 2018-03-02 23:22:36 +01:00
Adam Wulkiewicz
20a83095a0 [doc][area] Add documentation for geographic strategy and improve example (use strategies). 2018-01-16 15:22:52 +01:00
Adam Wulkiewicz
6d0d53c41e Merge branch 'develop' into feature/area_strategies 2018-01-16 14:45:48 +01:00
Adam Wulkiewicz
f35a4f927e [doc][densify] Add documentation for densify algorithm and strategies.
Change strategies from structs to classes as this is the requirement of
the docs generating tool.
2018-01-12 03:01:01 +01:00
Adam Wulkiewicz
127b52ea0c [doc] Change names after renaming surveyor to cartesian (area strategy). 2017-12-22 23:24:02 +01:00
Mateusz Łoskot
7e08464fff [doc] Add doxygen files clean-up if run with --release-build
Delete Doxygen-generated files to avoid copying them into release archive.
Replace os.remove with shutil.rmtree to cope with sub-directories.
2017-03-28 02:09:34 +02:00
Adam Wulkiewicz
60592cff99 [doc] Update reference (area strategy, set operations, is_simple, is_valid).
Remove area::huiller, add area::spherical strategy.
Distinguish between versions of algorithms taking and not taking strategies.
2017-03-05 20:24:23 +01:00
barendgehrels
9e3fcdb8f9 [doc] update renaming from ublas_transformer to matrix_transformer 2017-01-04 15:45:54 +01:00
Rene Rivera
28c9d63b2d Add option to specify path to doxygen_xml2qbk tool. 2016-10-09 22:00:33 -05:00
Rene Rivera
f13b300eb4 Support avoiding running b2 in new release doc builds. 2015-12-21 21:17:32 -06:00
Menelaos Karavelas
bf6bc4b5aa [doc][strategies][distance][cross track point box] add documentation
for cross_track_point_box distance strategy
2015-06-13 01:54:49 +03:00
Menelaos Karavelas
bd6cc0e5d3 [doc][algorithms][is_empty] add documentation for is_empty algorithm 2015-06-03 01:08:33 +03:00
Adam Wulkiewicz
45dc5fd0e4 [doc] Add documentation and examples for relate() and relation() algorithms.
Add also documentation for DE-9IM classes.
2015-05-01 16:49:11 +02:00
Menelaos Karavelas
32635987e8 [doc][algorithms][num_segments] add back documentation for num_segments algorithm 2014-10-27 22:18:07 +02:00
Menelaos Karavelas
6769ad34f4 [doc][num_segments] remove references to the num_segments algorithm;
to be added back in boost 1.58;
2014-10-20 01:04:56 +03:00
Menelaos Karavelas
e98bfaca4a Merge branch 'develop' of https://github.com/boostorg/geometry into feature/num_segments 2014-07-29 00:34:33 +03:00
Adam Wulkiewicz
22f622773e [doc] Remove multi/multi.hpp convenient header 2014-07-26 22:35:08 +02:00
Barend Gehrels
d945001bbf [buffer][doc] Add documentation for side_straight, extended doc for buffer with strategies 2014-07-20 13:29:07 +02:00
Barend Gehrels
0b635e342d [buffer] rename buffer_circle to point_circle to have it consistent with other strategies,
and buffer is already in the namespace. same for buffer_square -> point_square
2014-07-20 10:38:40 +02:00
Barend Gehrels
c12701bb40 [buffer] documentation of 6 distance strategies 2014-07-19 23:05:45 +02:00
Barend Gehrels
46068123b9 [buffer] create documentation about PointStrategy (buffer_circle)
add buffer_square as alternative
2014-07-19 14:36:39 +02:00
Menelaos Karavelas
c523754768 [doc] add num_segments algorithm 2014-07-17 03:04:12 +03:00
Adam Wulkiewicz
e9178b6a80 Merge pull request #75 from mkaravel/feature/is_simple
Feature/is simple
2014-07-01 17:27:01 +02:00
Menelaos Karavelas
1465ada4ba [doc][stratiegies][distance] add pythagoras point-box and box-box strategies 2014-06-27 03:37:00 +03:00
Menelaos Karavelas
ff8d26e3e9 [doc][is_simple, is_valid] add doxygen and qbk support for documentation
of is_simple and is_valid; add qbk doc for is_simple and is_valid;
add example for is_simple and is_valid;
2014-06-27 02:35:33 +03:00
Barend Gehrels
46a5e4e090 [doc] Updated make_qbk 2014-05-07 11:57:21 +02:00
Adam Wulkiewicz
ec576e827c [doc] Change non-portable run_command rm to os.remove in make_qbk scripts 2014-04-19 02:29:54 +02:00