mbarbin/doc-experiment-sphinx
1
2
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
Experimenting with documentation tools
22 commits 2 branches 0 tags 3.3 MiB
  • OCaml 48.4%
  • Makefile 48.3%
  • Dune 3.3%
Find a file
Exact
Mathieu Barbin 9476f19c27
 Fix typo in README.md
2024-07-21 11:23:52 +02:00
.github/workflows Disabled Jekyll entirely. 2023-03-31 12:45:48 +02:00
bin init 2023-03-30 12:33:03 +02:00
doc bump sphinx_rtd_theme requirement 2023-03-31 00:25:13 +02:00
lib/doc_experiment using mdx 2023-03-30 12:49:51 +02:00
.gitattributes init 2023-03-30 12:33:03 +02:00
.gitignore init 2023-03-30 12:33:03 +02:00
.ocamlformat init 2023-03-30 12:33:03 +02:00
.readthedocs.yaml added readthedocs config 2023-03-30 15:10:02 +02:00
doc-experiment.opam using mdx 2023-03-30 12:49:51 +02:00
dune init 2023-03-30 12:33:03 +02:00
dune-project using mdx 2023-03-30 12:49:51 +02:00
LICENSE init 2023-03-30 12:33:03 +02:00
Makefile attempt to build and deploy sphinx + odoc to gh-pages 2023-03-30 23:18:21 +02:00
README.md Fix typo in README.md 2024-07-21 11:23:52 +02:00

README.md

doc-experiment-sphinx

Actions Status Deploy doc Actions Status Documentation Status

⚠️ I have migrated my experimentation to this repository instead.

This is a toy project that I use to experiment with documentation tools. In particular I'd like to see if I can get a doc hosted on github pages (or a platform such as readthedocs.io), which would be built using markdown files with mdx enabled, including OCaml libraries API documentation (odoc).

At the moment I haven't found a way to have both docs share a search index. This is work in progress.