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 generated index.html too verbose ? #13155

Closed
Casteran opened this issue Oct 7, 2020 · 4 comments · Fixed by #17045
Closed

coqdoc generated index.html too verbose ? #13155

Casteran opened this issue Oct 7, 2020 · 4 comments · Fixed by #17045
Labels
kind: design discussion Discussion about the design of a feature. kind: documentation Additions or improvement to documentation. part: coqdoc The coqdoc binary for building documentation.
Milestone

Comments

@Casteran
Copy link

Casteran commented Oct 7, 2020

Hi,

The file index.html generated by coqtop contains a lot of links associated with bound variables.
For instance, the following lemma

Lemma eq_b_iff (alpha beta : T1) :
  eq_b alpha beta = true ↔ alpha = beta.

generates the entry

alpha:130 [binder, in hydras.Epsilon0.T1]

The same problem occurs even in the case of an explicitely quantified variable.
Thus, I get at least one thousand entries for the variable alpha !

Is it possible to tell coqdoc not to insert binders in the index ?

Pierre
(on Coq 8.12.0 (July 2020))

Coq Version

@Casteran
Copy link
Author

Casteran commented Oct 7, 2020

Hello,

Perhaps it's just a problem of readability : Roughly 2/3 of the global index entries are binder entries (whose name is not so relevant), and the file index.html starts with the global index, where this amount of entries is merged with lemmas, definitions, etc. So, it's better to skip the global index and jump to specialized indices (at the end of the page).
Is the global index at the beginning of the page really useful, since the same information is sorted and displayed later ?

Best regards,

Pierre

@Alizter Alizter added kind: design discussion Discussion about the design of a feature. kind: documentation Additions or improvement to documentation. part: coqdoc The coqdoc binary for building documentation. labels Sep 29, 2021
@palmskog
Copy link
Contributor

For the record, I have hit this issue multiple times in multiple Coq projects: the binder index takes up half or more of the global index and leads to huge HTML files. This is especially annoying when using GitHub Pages in the gh-pages branch, which has to hold all the redundant HTML. In my opinion, binder indexes should not be generated by default, but only after passing a flag.

@SkySkimmer
Copy link
Contributor

The binder index seems to have been introduced by #12033 (8.12), indeed it doesn't appear in https://coq.inria.fr/distrib/V8.11.0/stdlib/genindex.html
However it doesn't seem to have been the main point of the PR, which is more about having a link between the 2 xs in fun x => x.
cc @herbelin

@herbelin
Copy link
Member

I did not realize that adding links for binders would create an index. I don't think it is useful indeed.

@Alizter Alizter added this to Fixing in User documentation May 17, 2022
@Alizter Alizter added this to Cleanup in coqdoc May 23, 2022
coqdoc automation moved this from Cleanup to Done Jan 2, 2023
@coqbot-app coqbot-app bot added this to the 8.18+rc1 milestone Jan 2, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind: design discussion Discussion about the design of a feature. kind: documentation Additions or improvement to documentation. part: coqdoc The coqdoc binary for building documentation.
Projects
Archived in project
coqdoc
  
Done
Development

Successfully merging a pull request may close this issue.

5 participants