Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Migration of the manual into odoc #325

Merged
merged 3 commits into from
Jun 3, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 1 addition & 5 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,7 @@ test:
dune runtest

doc:
cd doc && sphinx-build . _build

livedoc:
cd doc && sphinx-autobuild . _build \
-p 8888 -q --host $(shell hostname) -r '\.#.*'
dune build @doc

clean:
dune clean
Expand Down
160 changes: 0 additions & 160 deletions doc/conf.py

This file was deleted.

2 changes: 2 additions & 0 deletions doc/dune
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
(documentation
(package ppxlib))
30 changes: 30 additions & 0 deletions doc/index.mld
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
{0 Ppxlib's user manual}

{1 Overview}

This is the user manual and api for ppxlib, the core of the ppx meta-programming
system for {{:https://ocaml.org/}OCaml} and its derivatives such as
{{:https://reasonml.github.io/}Reason}. This manual is aimed at both users and
authors of ppx rewriters and contains everything one should know in order to use
or write ppx rewriters.

It is assumed in this manual that the user is familiar with the
{{:https://dune.build/}Dune} build system. In particular, all the examples in
this manual referring to the build system will present
{{:https://dune.build/}Dune} configurations files and commands. It is possible
to use ppxlib with other build systems, however this is not covered by this
manual.

{1 Manual}

The {{!page-manual}manual} consists of three main sections:

- {{!page-manual."what-is-ppx"}What is ppx}
- {{!page-manual."ppxlib-for-end-users"}Ppxlib for end users}
- {{!page-manual."ppxlib-for-plugin-authors"}Ppxlib for plugin authors}

{1 API}

The API exposes the following modules:

{!modules: ppxlib ppxlib_ast astlib ppxlib_metaquot Ppxlib_metaquot_lifters Ppxlib_print_diff Ppxlib_runner Ppxlib_runner_as_ppx Stdppx Ppxlib_traverse Ppxlib_traverse_builtins}
36 changes: 0 additions & 36 deletions doc/index.rst

This file was deleted.

Loading