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

Better support for coqdoc #75

Open
annenkov opened this issue Dec 1, 2021 · 1 comment
Open

Better support for coqdoc #75

annenkov opened this issue Dec 1, 2021 · 1 comment

Comments

@annenkov
Copy link

annenkov commented Dec 1, 2021

It seems like not all coqdoc comments are handled currently. I run into the following issues:

  • coqdoc inside definitions renders as comments (** ... *)
  • hiding with (* begin hide *) ... (* end hide *) doesn't work.

Here is an example

From Coq Require Import List.

(** * Some functions on lists *)

(** My definition of the [map] function *)

Fixpoint my_map {A B} (f : A -> B) (xs : list A) :=
  match xs with
(** coqdoc inside the definition *)
  | nil => nil
(** more coqdoc *)
  | cons x xs => cons (f x) (my_map f xs)
  end.

(* begin hide *)

Definition should_be_hidden : nat := 0.

(* end hide *)

Alectryon command

alectryon AlectrionCoqdoc.v --frontend coqdoc --backend webpage

Alectryon output

AlectrionCoqdoc_v

Coq version

The Coq Proof Assistant, version 8.11.2 (November 2021)
compiled on Nov 17 2021 10:04:59 with OCaml 4.08.1
@cpitclaudel
Copy link
Owner

That's right; the coqdoc frontend was mostly intended as a demonstration, and I haven't worked that much on it. In the long run the hope was the documents would be migrated away from Coqdoc, but I'd welcome help in making support for it better in the meantime.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants