Commit Graph
43 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 3c08a06f38 Move to a shorter filename. 2024-09-26 09:21:40 -04:00
Ryan Curtin defe9df2a4 Fix links in documentation. 2024-09-25 22:39:05 -04:00
Ryan Curtin d696137a42 Add first pass at documentation for data::Split(). 2024-09-25 15:56:40 -04:00
Omar Shrit fbc5d978d0 Merge pull request #3795 from shrit/embed_doc_1
Embed doc 1
2024-09-20 11:29:12 +02:00
Omar Shrit 19791acb19 Make the index shorter
Signed-off-by: Omar Shrit <omar@avontech.fr>
2024-09-16 19:26:02 +02:00
Ryan Curtin 140a8782d0 Merge pull request #3787 from rcurtin/radical-doc
Document `Radical`
2024-09-11 09:45:40 -04:00
Ryan Curtin 763d0f6c31 Merge remote-tracking branch 'origin/master' into core-into-multiple-pages 2024-09-09 14:02:49 -04:00
Ryan Curtin fa6d85e2f9 Make better pointers to individual core documentation pages. 2024-09-07 09:29:14 -04:00
Ryan Curtin ea73c7f242 Merge remote-tracking branch 'origin/master' into radical-doc 2024-08-28 21:53:31 -04:00
Ryan Curtin 536a9adea0 Add documentation for RADICAL. 2024-08-28 16:57:59 -04:00
Ryan Curtin 7161eb5128 Add notes indicating that documentation is not yet complete. 2024-08-24 13:12:55 -04:00
Omar Shrit d3a3ebe1cf Docs: armv7, pi 2, crosscompile
Signed-off-by: Omar Shrit <omar@avontech.fr>
2024-07-24 22:52:29 +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 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 cccf60d974 Move metrics to distances/ and dists to distributions/. And adapt... everything. 2024-06-14 15:14:48 -04:00
Ryan Curtin 4a342fa313 Document AMF and adapt for multiple element types. 2024-06-06 17:33:02 -04:00
Ryan Curtin 22ff9cb245 Merge branch 'master' into website-revamp 2024-05-24 07:22:00 -06:00
Ryan Curtin b9610bdec6 Add documentation for LocalCoordinateCoding. 2024-05-18 17:37:55 -04:00
Ryan Curtin b7cb52e075 Move community and GSoC pages away from website and into documentation. 2024-05-14 22:59:09 -04:00
Ryan Curtin 4f9b0ceb6a Add SparseCoding to sidebar and index page. 2024-05-13 16:52:29 -04:00
Ryan Curtin 2a217dec05 Merge remote-tracking branch 'origin/master' into website-revamp 2024-05-02 18:16:54 -04:00
Ryan Curtin 0e9491384a Update HISTORY.md so that it is also built into a webpage. 2024-05-02 13:40:01 -04:00
Ryan Curtin f0f24cf881 Some minor additional cleanups. 2024-05-02 11:18:35 -04:00
Ryan Curtin ac37df3bb0 Add documentation for NMF and convenience typedef from AMF. 2024-04-11 11:01:56 -04:00
Ryan Curtin 6586ed6fb6 Merge pull request #3677 from rcurtin/pca-doc
Document `PCA`
2024-04-09 08:51:53 -04:00
Ryan Curtin 918f8c25f5 Add more links to sidebar, including CV/HPT. 2024-04-03 17:48:18 -04:00
Ryan Curtin 276dc85aac Fix links in PCA documentation. 2024-04-03 13:57:34 -04:00
Ryan Curtin b3fd17e65f Add documentation for PCA. 2024-04-02 14:54:21 -04:00
Ryan Curtin ac114f2331 Add some missing links. 2024-03-20 20:06:11 -04:00
Ryan Curtin bc793428e6 Add missing methods to documentation. 2024-03-13 12:07:02 -04:00
Ryan Curtin 72cf442586 Fix all broken links and handle a few other TODOs. 2024-02-26 20:13:04 -05:00
Ryan Curtin b5c3c66613 Fix minor syntax issue. 2024-02-21 16:38:31 -05:00
Ryan CurtinandJames J Balamuta 31672e77f0 Update doc/index.md
Co-authored-by: James J Balamuta <coatless@users.noreply.github.com>
2024-02-21 16:21:45 -05:00
Ryan Curtin 680fee01be Add a link to the C++ quickstart. 2024-02-21 16:19:24 -05:00
Ryan Curtin 1a5275745f Add a link to the CLI quickstart. 2024-02-21 16:17:01 -05:00
Ryan CurtinandJames J Balamuta 209a5cd8b6 Update doc/index.md
Co-authored-by: James J Balamuta <coatless@users.noreply.github.com>
2024-02-21 16:13:52 -05:00
Ryan Curtin 7f908c49d1 Add a link to the binding documentation. 2024-01-30 18:25:28 -05:00
Ryan Curtin e8a68cf8f7 Add additional links for newly documented methods. 2024-01-13 12:48:00 -05:00
Ryan Curtin 6edd1104b5 Minor changes and fixes. 2024-01-13 12:39:36 -05:00
Ryan Curtin 3ee57fdeca Add algorithm sections to index page. 2024-01-11 16:49:32 -05:00
Ryan Curtin bd428901c8 Add first pass at main documentation page. 2023-12-21 11:00:14 -05:00