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

coqdoc --html does not work properly when invoked from a parent folder #2366

Open
coqbot opened this issue Jul 23, 2010 · 2 comments
Open

coqdoc --html does not work properly when invoked from a parent folder #2366

coqbot opened this issue Jul 23, 2010 · 2 comments
Labels
good first issue Beginners welcome to submit a pull request. part: coqdoc The coqdoc binary for building documentation. part: tools Coqdoc, coq_makefile, etc.

Comments

@coqbot
Copy link
Contributor

coqbot commented Jul 23, 2010

Note: the issue was created automatically with bugzilla2github tool

Original bug ID: BZ#2366
From: @erikmd
Reported version: 8.2
CC: @herbelin, @glondu

@coqbot
Copy link
Contributor Author

coqbot commented Jul 23, 2010

Comment author: @erikmd

When I execute for instance the command:

$ coqdoc -toc -html -d html theories/*.v

(or a similar one invoked by a Coq Makefile),
the generated HTML files are of lower quality than by doing sth like

$ cd theories && coqdoc -toc -html -d html *.v

More precisely,

  1. all identifiers are preceded by <span class="id" type="var">,
    whenever is their real type (section, lemma, tactic, etc.),
    thus the HTML files do not respect the color code any more;
  2. moreover, these files do not contain any more hyperlink tags
    <a name="..."> nor <a class="idref" href="...">;
  3. and in the generated index.html file, all links are broken
    (except the last few links of the Library Index), i.e.
    the filename prefix "theories." corresponding to the
    folder at stake is missing.

This is reproducible with 8.2pl2.

Kind regards,
Erik.

@coqbot
Copy link
Contributor Author

coqbot commented Jul 24, 2010

Comment author: @glondu

When I execute for instance the command:
$ coqdoc -toc -html -d html theories/*.v
(or a similar one invoked by a Coq Makefile),
the generated HTML files are of lower quality than by doing sth like
$ cd theories && coqdoc -toc -html -d html *.v

This and bug BZ#2363 make me think that coqdoc should accept a {make,tar}-style "-C" option.

@coqbot coqbot added the part: tools Coqdoc, coq_makefile, etc. label Oct 18, 2017
@ejgallego ejgallego added the good first issue Beginners welcome to submit a pull request. label Oct 25, 2017
@Zimmi48 Zimmi48 added the part: coqdoc The coqdoc binary for building documentation. label Apr 5, 2020
@ejgallego ejgallego added this to Optional / After merge in Dune May 1, 2021
@Alizter Alizter added this to Bugs in coqdoc May 23, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Beginners welcome to submit a pull request. part: coqdoc The coqdoc binary for building documentation. part: tools Coqdoc, coq_makefile, etc.
Projects
Dune
  
Forward to Dune
coqdoc
  
Bugs
Development

No branches or pull requests

3 participants