Commit Graph
62 Commits
Author SHA1 Message Date
Ryan CurtinandDirk Eddelbuettel e70a04fbba Add Docker deployment documentation (#3907)
* Add a first attempt at explicitly using Jenkinsfiles.

* A first attempt...

* Put code in a script block.

* Add first attempt at link check job pipeline.

* Hopefully correct shell block.

* Install git.

* Install packages as root.

* Use custom image that already has dependencies installed.

* Try processing the JUnit results.

* Fix syntax (hopefully).

* Try to get the build to set its status on Github.

* Try and see if I can get the snippet build to run too.

* A first attempt at reviving the static code analysis build.

* Refactor style check job a bit.

* Try to clean up other files and have them set statuses.

* Set status in script blocks.

* Fix directory (this may not fix my problem).

* Should I load in the script step?

* Maybe I can just load it without a name.

* Maybe I have my path wrong.

* Will this work?  Just a test...

* Try using a plugin instead.

* And if I define the function manually at the top?

* Maybe this will fix the load.

* Try to turn unstable into failed.

* Hopefully fix documentation builds.

* Fix script blocks.

* Maybe fix static code analysis job.

* Try to adapt PR number variable.

* First attempt at cross-compilation job.

* Try to fix some syntax.

* Clean workspaces after build.

* Try to put the matrix in the right place.

* Another attempt at the matrix configuration.

* Maybe I have to nest it deeper.

* Maybe I have to clean always?

* What we need is more tabbing.

* Use try/catch to handle failed junit processing.

* Better handling of environment variables.

* Try a differernt approach than try/catch.

* Try to get some more information about ccache.

* Is it possible we could store the ccache at a higher level?

* Maybe I have the variable name wrong.

* Clean the cross-compilation workspace.

* Try mounting the ccache so it can be shared across multiple jobs.

* Always pull images.

* We need to run on the same node.

* Run on only one core.

* Try building in the Docker container in a different way.

* Do I have the order backwards?

* Can I run anything at all in the container?

* The static code analysis job isn't helpful.

* Try to set the user of the docker container.

* Rebuild the Docker container instead.

* Always pull an updated image.

* Download any necessary dependencies too.

* Oops, use the correct CMake options.

* Fix line break in the wrong place.

* Make sure to use the correct architecture.

* We can't use MATCHES, that is a regex.

* Oops, we need to use STREQUAL.

* Bump to an older version since newer versions don't have gfortran.

* Try to run the tests on the target.

* Correct syntax.

* Okay, I'm not allowed to generate a stage name.

* Try cleaning the workspace at the start of the build.

* Okay, so I just can't depend on the workspace cleaning job, wonderful.

* Try and add the passphrase correctly.

* Fix path for memory checks.

* Fix path to test.

* Fix PR number variable.

* Try to fix path for test copying.

* Try to get the PR number correct.

* Try and centralize where the link cache is stored.

* Why is it being printed strangely?

* Is there some weird restriction where this all has to be on one line?

* Always publish the HTML, and fix a link.

* Try to fix SSH host key check.

* Make the reports directory.

* Try to fix file parsing.

* Try to enable ccache.

* Try to set ccache directory correctly.

* Try to get the full pipeline set up correctly for cross-compilation.

* Fix path to test data.

* Allow debug builds when cross-compiling.

* Remember to unpack all the test data!

* Fail tests when the data isn't there.

* Maybe I can use find instead.

* Double escape for backslash?

* What if we just run the test?

* Port Catch2 improvement for junit runner.

See https://github.com/catchorg/Catch2/commit/c29e198eab0ccdb190495397854b937677385e2e.

* Re-enable junit testing (hopefully it will work now).

* Output directly to the xml file.

* Try to clean up regex.

* Try to set IN PROGRESS status.

* Could it be called RUNNING?

* I guess I don't get access to set jobs in progress through this API.

* Fix regex for test name extraction.

* Try to clean up Jenkinsfiles.

* Fix parameter name.

* Maybe fix syntax?

* Does it work without keyword arguments?

* Correctly accept named parameters.

* Abort previous builds to reduce load on Jenkins.

* Use optimization when compiling.

* Fix syntax for abortPrevious.

* Fix missing closing brace...

* Update links in CI documentation and try to fix memory check job.

* Add Docker deployment page.

* Fix link.

* Fix missing link in pipeline.

* Apply suggestions from code review

Co-authored-by: Dirk Eddelbuettel <edd@debian.org>

* Try to get some more information on the build failure.

* Fix link that now redirects.

* Try to get some more information about why we are not linking against OpenBLAS.

* I think the variable name was wrong, we will see...

* Clean things up since the build should work now.

---------

Co-authored-by: Dirk Eddelbuettel <edd@debian.org>
2025-03-12 16:49:34 -04:00
Ryan Curtin 0737eb0dc6 Document RPlusTree and RPlusPlusTree (#3897) 2025-03-03 01:13:53 +01:00
Ryan Curtin 097d3cc214 Document HilbertRTree (#3891) 2025-02-24 03:51:32 +01:00
Ryan Curtin 639244dc58 Document RStarTree (#3888) 2025-02-19 01:35:45 +01:00
Ryan Curtin e60b566e8c Document XTree (#3890) 2025-02-19 01:13:14 +01:00
Ryan CurtinandDirk Eddelbuettel e30f83c028 Document RectangleTree and RTree (#3885)
* First attempt at documenting the RectangleTree.

* Add Insert() and Delete() to RectangleTree; they have a nicer user interface than what was previously there.

* Add R-tree documentation.

* Fix default arguments for RectangleTree typedefs.

* Fix some minor documentation display issues.

* Fix link.

* Fix links.

* Try to clarify what trees are a little bit.

* Apply suggestions from code review

Co-authored-by: Dirk Eddelbuettel <edd@debian.org>

* Update doc/user/core/trees/r_tree.md

Co-authored-by: Dirk Eddelbuettel <edd@debian.org>

---------

Co-authored-by: Dirk Eddelbuettel <edd@debian.org>
2025-02-12 15:17:21 -05:00
Ryan Curtin 6daac5027d Add documentation for Octree (#3880) 2025-01-28 05:47:21 +01:00
Ryan Curtin aca8af3ebc Document CoverTree (#3861)
* Document the cover tree.

* Fix links.

* Fix compilation issues in examples by allowing default construction of cover trees.
2025-01-03 16:34:45 -05:00
Ryan Curtin c8eb3dceac Overhaul documentation homepage (#3836)
* Add pipeline to documentation homepage.

* Fix for mobile devices.

* Add little pipelines to go at the top of each page.

* Overhaul index page.

* Overhaul README to remove redundant material.

* Add installation documentation.

* Update pipelines.

* Allow nesting of deeper details.

* Add a pipeline to the top of the load/save page.

* Add prerequisites link to main pipeline.

* Add better but not finished sidebar.

* Add a couple new documentation pages.

* Fix URLs in svg.

* Incremental checkin.

* Fix Youtube URLs.

* Incremental checkin.

* Minor fixes.

* Add first pass at evaluation/deployment pages.

* Minor spacing and link fixes.

* Flesh out a number of additional pages and write basic compilation documentation.

* Fix some minor issues, and add Docker deployment page (not totally finished yet).

* Add developer documentation landing page.

* Hopefully getting close to the final set of changes here.

* Remove this documentation for now.

* Fix a few links, and the size of the sidebar.

* Fix some additional links.

* Fix a bunch more links.

* Fix another link that now has a better place.

* Refactor test-docs.sh to handle documentation that is a standalone program.

* Fix file exclusions.

* Fully qualify typename.

* Update name of file.

* Fix syntax error.

* Remove files that are not meant to be compiled.

* Also skip the quickstart.

* Move quickstart entry to the top.

* Remove gray coloring of binding documentation.

* Update name of sidebar link.

* Update to working link.

* Fix Wikipedia anchor.
2024-12-20 13:36:12 -05:00
Omar Shrit 6384c0598e Merge branch 'master' into docs_table
Signed-off-by: Omar Shrit <omar@avontech.fr>
2024-11-07 15:54:06 +01:00
Omar Shrit 108b25357c Fix links, and the sidebar
Signed-off-by: Omar Shrit <omar@avontech.fr>
2024-11-05 22:52:57 +01:00
Ryan Curtin 3c4ead453b Merge remote-tracking branch 'origin/master' into doc-rp-trees 2024-11-04 09:13:38 -05:00
Ryan Curtin 66bb13648d Merge remote-tracking branch 'origin/master' into doc-rp-trees 2024-10-25 10:20:38 -04:00
Ryan Curtin f09846cc2b Merge remote-tracking branch 'origin/master' into doc-ub-tree 2024-10-23 17:37:52 -04:00
Ryan Curtin c605720837 Document UB-tree. 2024-10-21 21:23:44 -04:00
Ryan Curtin f8ed3cf2cd Fix merge artifact (duplicate BinarySpaceTree). 2024-10-16 20:45:51 -04:00
Ryan Curtin d545a99713 Update sidebar. 2024-10-16 15:17:37 -04:00
Ryan Curtin ef8d0df872 Merge remote-tracking branch 'origin/master' into doc-vptree 2024-10-16 12:26:53 -04:00
Ryan Curtin 96bf8e34f5 Merge pull request #3806 from rcurtin/doc-mean-split-ball-tree
Document `MeanSplitBallTree`
2024-10-10 09:52:36 -04:00
Ryan Curtin 6753194fee Merge pull request #3803 from rcurtin/doc-split
Add documentation for `Split()` and `StratifiedSplit()`
2024-10-10 09:51:17 -04:00
Ryan Curtin 7644d879fd Merge remote-tracking branch 'origin/master' into doc-mean-split-ball-tree 2024-10-04 15:18:01 -04:00
Ryan Curtin 02a2b61e37 Fix ordering of trees. 2024-10-02 15:21:31 -04:00
Ryan Curtin 4ccc2cf6bf First steps towards documenting VPTree. 2024-10-02 10:32:55 -04:00
Ryan Curtin ebbee415e2 Merge remote-tracking branch 'origin/master' into doc-split 2024-09-30 16:11:38 -04:00
Ryan Curtin 299a80a307 Merge remote-tracking branch 'rcurtin/doc-ball-tree' into doc-mean-split-ball-tree 2024-09-30 14:50:07 -04:00
Ryan Curtin 1bbe494936 Merge remote-tracking branch 'origin/master' into doc-mean-split-ball-tree 2024-09-30 14:49:36 -04:00
Ryan Curtin 4e654ea321 Document MeanSplitBallTree. 2024-09-30 14:48:28 -04:00
Ryan Curtin 14fe038844 Merge remote-tracking branch 'origin/master' into doc-ball-tree 2024-09-30 11:50:39 -04:00
Ryan Curtin a64caf14ad Fix link for dataset splitting page. 2024-09-26 10:52:18 -04:00
Ryan Curtin 69fc1416f7 Fixes for documentation. 2024-09-25 16:13:29 -04:00
Ryan Curtin d696137a42 Add first pass at documentation for data::Split(). 2024-09-25 15:56:40 -04:00
Ryan Curtin 9d959099c2 Add documentation for BallBound and BallTree. 2024-09-25 12:47:18 -04:00
Ryan Curtin ca520f8165 Document MeanSplit and MeanSplitKDTree. 2024-09-23 17:37:01 -04:00
Omar Shrit 8afe0fd32a Merge pull request #3794 from rcurtin/kdtree-doc
Document `KDTree` and `BinarySpaceTree` and related classes
2024-09-23 18:20:49 +02:00
Omar Shrit fbc5d978d0 Merge pull request #3795 from shrit/embed_doc_1
Embed doc 1
2024-09-20 11:29:12 +02:00
Ryan Curtin 7ffdfd9ca6 Refactor tree documentation according to feedback. 2024-09-17 17:09:05 -04:00
Omar Shrit e104013a0a Resolve all comments from @rcurtin
Signed-off-by: Omar Shrit <omar@avontech.fr>
2024-09-16 13:02:09 +02:00
Ryan Curtin e15e79157f Merge remote-tracking branch 'origin/master' into kdtree-doc 2024-09-11 14:18:29 -04:00
Ryan Curtin 9a43b7b500 Minor differences and changes for documentation. 2024-09-11 14:18:01 -04:00
Ryan Curtin 140a8782d0 Merge pull request #3787 from rcurtin/radical-doc
Document `Radical`
2024-09-11 09:45:40 -04:00
Ryan Curtin bb5864b027 Merge remote-tracking branch 'origin/master' into radical-doc 2024-09-09 14:05:02 -04:00
Ryan Curtin 72309471d2 First attempt at splitting core.md into multiple pages. 2024-09-06 09:48:17 -04:00
Ryan Curtin 7ef9665b3b Temporarily address organizational issues via the sidebar. 2024-09-04 11:42:48 -04:00
Ryan Curtin 536a9adea0 Add documentation for RADICAL. 2024-08-28 16:57:59 -04:00
Omar Shrit bb354f12f5 Add it to the sidebar, and see if this make sense
Signed-off-by: Omar Shrit <omar@avontech.fr>
2024-07-28 16:58:38 +02:00
Ryan Curtin fb9da0b892 Merge remote-tracking branch 'origin/master' into mean-shift-doc 2024-07-21 18:18:01 -04:00
Ryan Curtin 9a925ccbdc Fix link in sidebar. 2024-07-18 15:56:53 -04:00
Ryan Curtin 01a16cefbf Update main documentation page and sidebar. 2024-07-17 22:09:00 -04:00
Ryan Curtin 4a2af775f6 Add links to NCA and LMNN to index and sidebar. 2024-07-06 12:41:09 -04:00
Ryan Curtin 4a342fa313 Document AMF and adapt for multiple element types. 2024-06-06 17:33:02 -04:00