Commit Graph
49 Commits
Author SHA1 Message Date
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
Ryan Curtin 330b017891 Freelists has a redirect now. 2024-11-16 21:07:26 -05:00
Ryan Curtin 9b1824b25f Try a website that's not down. 2024-11-16 21:00:32 -05:00
Ryan Curtin 3c4ead453b Merge remote-tracking branch 'origin/master' into doc-rp-trees 2024-11-04 09:13:38 -05:00
Omar Shrit 67ef37e3c6 Merge pull request #3815 from rcurtin/doc-ub-tree
Document `UBTree`
2024-10-31 17:09:02 +01:00
Ryan Curtin 66bb13648d Merge remote-tracking branch 'origin/master' into doc-rp-trees 2024-10-25 10:20:38 -04:00
Martin Lambertsen 855a22f267 Modernize typedefs in docs 2024-10-25 11:20:47 +02:00
Ryan Curtin f09846cc2b Merge remote-tracking branch 'origin/master' into doc-ub-tree 2024-10-23 17:37:52 -04:00
Ryan Curtin cac046a9c1 Add links to UBTree documentation. 2024-10-21 21:26:18 -04:00
Martin Lambertsen f05ae22d60 Merge remote-tracking branch 'origin/master' into feature/modernize-type-traits 2024-10-17 06:56:56 +02:00
Ryan Curtin d545a99713 Update sidebar. 2024-10-16 15:17:37 -04:00
Martin Lambertsen 471a3daa27 Modernize STL type traits
With newer standards the readability of template heavy code can
be improved a lot by using a form with trailing _t for ::type and
_v for ::value respectively. Especially for ::type it also makes
the additional typename before the trait dispensable.

This PR combines multiple commits that modernize the traits,
starting with what clang-tidy could achieve while analyzing test files
and continuing by regex replaces with few manual corrections.

While it does not guarantee that all current occurrences are modernized,
it moves the codebase considerably into the modern direction. Note that
also before this PR both notations were used, so missing a few should
be acceptable.
2024-10-14 08:28:05 +02: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 9d959099c2 Add documentation for BallBound and BallTree. 2024-09-25 12:47:18 -04:00
Ryan Curtin d79111f86b Update links in TreeType API documentation. 2024-09-23 17:38:26 -04:00
Ryan Curtin 62275b0571 Fix links in documentation. 2024-09-19 09:16:05 -04:00
Ryan Curtin f21ce5016d Fix minor issues in examples. 2024-09-12 19:36:09 -04:00
Ryan Curtin b963b60815 Add documentation for trees in its own file. 2024-09-12 18:33:13 -04:00
Ryan Curtin ade86a033f Merge branch 'core-into-multiple-pages' into kdtree-doc 2024-09-07 16:01:52 -04:00
Ryan Curtin 936224b45f Fix all links in generated documentation. 2024-09-06 22:30:14 -04:00
Ryan Curtin d2a470b71d First pass at documenting kd-trees. 2024-09-05 11:32:02 -04:00
Ryan Curtin 06cb3982ff Fix developer.md code build. 2024-06-25 10:24:16 -04:00
Ryan Curtin 141790ce20 More links to fix... 2024-06-16 11:52:27 -04:00
Ryan Curtin 4ad3957bba Merge remote-tracking branch 'origin/master' into metric-doc 2024-06-14 15:39:32 -04:00
Ryan Curtin cccf60d974 Move metrics to distances/ and dists to distributions/. And adapt... everything. 2024-06-14 15:14:48 -04:00
Ryan Curtin 7c0fc71f0c Update list of kernels to use links. 2024-06-12 09:09:48 -04:00
Ryan Curtin 806de3ca44 Better URL for books. 2024-06-06 20:02:41 -04:00
Ryan Curtin 401ede16e3 Fix bad links in new developer documentation. 2024-05-25 20:57:01 -04:00
Ryan Curtin b4348a0dd7 Fix incorrect link. 2024-05-25 16:37:01 -04:00
Ryan Curtin b7cb52e075 Move community and GSoC pages away from website and into documentation. 2024-05-14 22:59:09 -04:00
Abhimanyu Dayal ac8ff38ad3 Update bindings.md 2024-03-27 08:53:16 +05:30
Abhimanyu Dayal 7f1a6566ea Made minor changes to documentation - bindings.md 2024-03-27 01:54:20 +05:30
Ryan Curtin 72cf442586 Fix all broken links and handle a few other TODOs. 2024-02-26 20:13:04 -05:00
Ryan Curtin bd428901c8 Add first pass at main documentation page. 2023-12-21 11:00:14 -05:00
Aditya Raj 30a94a6549 Fixed misleading path 2023-02-06 17:30:05 +05:30
Aditya Raj 46bcedff81 Minor doc fix in bindings.md
I have encountered some minor doc issues while going through the file.
I have tried to fix some of them.

Thanks 
Adi
2023-02-03 19:10:28 +05:30
Adarsh SantoriaandRyan Curtin 58d3f1f515 Update doc/developer/trees.md
Co-authored-by: Ryan Curtin <ryan@ratml.org>
2023-02-02 01:19:07 +05:30
Adarsh SantoriaandRyan Curtin 430d071d11 Update doc/developer/trees.md
Co-authored-by: Ryan Curtin <ryan@ratml.org>
2023-02-02 01:17:45 +05:30
Adarsh Santoria 54ec3046c4 fixing typo in trees.md 2023-02-01 17:02:45 +05:30
Adarsh Santoria 152837ffd2 fixing links in kernels.md 2023-02-01 16:53:40 +05:30
Adarsh Santoria b4f7222af0 fixing links in metrics.md 2023-02-01 16:50:57 +05:30
Adarsh Santoria 0327f2edf8 fixing links in trees.md 2023-02-01 16:46:47 +05:30
Ryan Curtin 4b838602c7 Remove last references to doxygen in the documentation. 2022-12-02 09:29:21 -05:00
Ryan Curtin e6ad5f78c0 Remove namespaces (#3269) 2022-09-21 03:40:20 +02:00
Ryan Curtin 00e0dd2653 Clean up includes to only include mlpack.hpp in general. 2022-09-04 11:18:45 -04:00
Ryan Curtin 5825287e9b Adapt tutorials to Markdown and remove Doxygen entirely. 2022-08-31 23:02:27 -04:00