faiss

Commit Graph

Author	SHA1	Message	Date
Matthijs Douze	0815970581	Remove exclusion from Doxyfile (#2741 ) Summary: The Doxyfile is used to generate the Faiss documentation in faiss.ai. In its current config it skips over important classes like ProductQuantizer. Hence this diff that forces it to pass over the impl/ subdirectories. Pull Request resolved: https://github.com/facebookresearch/faiss/pull/2741 Reviewed By: mlomeli1 Differential Revision: D43732475 Pulled By: mdouze fbshipit-source-id: cf968238838051000fa31b4388e1f2beb7f451db	2023-03-02 04:48:50 -08:00
Lucas Hosseini	4774951982	GitHub actions hooks for GitHub pages docs website. (#1599 ) Summary: These hooks, along with the creation of the `gh-pages` branch with a Sphinx-powered website ([preview](https://beauby.github.io/faiss/)) will ensure automatic rebuild of the C++ API (doxygen) docs upon modification on `master`. Moreover, direct changes to the `gh-pages` branch will trigger a rebuild of the website as well. Pull Request resolved: https://github.com/facebookresearch/faiss/pull/1599 Reviewed By: wickedfoo Differential Revision: D25723322 Pulled By: beauby fbshipit-source-id: fafeed64b393dce8c569f9fd1f5bc3b004706589	2020-12-29 13:46:54 -08:00
Lucas Hosseini	38bf9f64e9	Get rid of stale generated docs. Summary: Those docs are not very useful as is, and having to re-generate the html manually leads to them being stale most of the time. Should we decide that we want to have them, we can bring them back with some automated generation. Reviewed By: mdouze Differential Revision: D24246072 fbshipit-source-id: 39798b2861ff25ee3fa1f95abdbc3e7ddf3469ed	2020-10-12 00:33:37 -07:00

Author

SHA1

Message

Date

Matthijs Douze

0815970581

Remove exclusion from Doxyfile (#2741 )

Summary:
The Doxyfile is used to generate the Faiss documentation in faiss.ai. In its current config it skips over important classes like ProductQuantizer. Hence this diff that forces it to pass over the impl/ subdirectories.

Pull Request resolved: https://github.com/facebookresearch/faiss/pull/2741

Reviewed By: mlomeli1

Differential Revision: D43732475

Pulled By: mdouze

fbshipit-source-id: cf968238838051000fa31b4388e1f2beb7f451db

2023-03-02 04:48:50 -08:00

Lucas Hosseini

4774951982

GitHub actions hooks for GitHub pages docs website. (#1599 )

Summary:
These hooks, along with the creation of the `gh-pages` branch with a Sphinx-powered website ([preview](https://beauby.github.io/faiss/)) will ensure automatic rebuild of the C++ API (doxygen) docs upon modification on `master`.
Moreover,  direct changes to the `gh-pages` branch will trigger a rebuild of the website as well.

Pull Request resolved: https://github.com/facebookresearch/faiss/pull/1599

Reviewed By: wickedfoo

Differential Revision: D25723322

Pulled By: beauby

fbshipit-source-id: fafeed64b393dce8c569f9fd1f5bc3b004706589

2020-12-29 13:46:54 -08:00

Lucas Hosseini

38bf9f64e9

Get rid of stale generated docs.

Summary: Those docs are not very useful as is, and having to re-generate the html manually leads to them being stale most of the time. Should we decide that we want to have them, we can bring them back with some automated generation.

Reviewed By: mdouze

Differential Revision: D24246072

fbshipit-source-id: 39798b2861ff25ee3fa1f95abdbc3e7ddf3469ed

2020-10-12 00:33:37 -07:00

3 Commits (1ee15ef3c34c6df1e72b806c00106b15fe35c3e5)