Comments (10)
Right now you can scroll in the search box to see up to 30 results. Do you want those results on a seperate page? (someone else would have to do that I don't know enough webdev for this) Or do you want to be able to see more than 30 results in the scroll? (that I can do)
from doc-gen4.
A separate page would be nice, but just being able to see all of the results in the scroll box is all I need practically. I also know a bit of web dev so I could try to add another page if that's something that would be valuable.
from doc-gen4.
Sure go for it!
from doc-gen4.
How do you set up a dev environment for doc-gen4? I'd like to build the docs for mathlib using my modified version of doc-gen4 in a neighboring directory.
from doc-gen4.
You change the version of the doc-gen4 in mathlib4 to point to your local directory as demonstrated here: https://github.com/leanprover/lake#syntax-of-require. Then you lake -Kdoc=on update
and from there on build docs with lake -Kdoc=on build Mathilb:docs
. Note that this does take quite a while so you might not necessarily want to build the docs for all of mathlib every time :P
from doc-gen4.
Ok thanks, I was able to build the docs, but when I open index.html in Firefox, it seems like the Same Origin policy is breaking the search functionality:
Cross-Origin Request Blocked: The Same Origin Policy disallows reading the remote resource at file:///C:/Users/Jeremy/Documents/mathlib4/build/doc/search.js. (Reason: CORS request not http).
I think I will need to set up a server to properly test it.
from doc-gen4.
I'm really having trouble with caching issues. I turned off network request caching in my browser. I am able to make changes to the lean files and see them show up when I rebuild the docs for my test package. However, I can't seem to figure out any way to get the style.css changes to show up, even when deleting the entire build directory. Could you give details about what you are doing so that your changes show up in the generated docs?
from doc-gen4.
style.css is included via meta programming, sadly we cannot yet (this is on the list) declare a dependency to lake via meta programming. What that means is that if you change style.css you also need to change the file that includes it or delete its build product (or the entire build of doc-gen4 if you want to be quick and dirty...and wait a little). This does tend to get a little annoying so sometimes when doing rapid development I just edit the style.css in the build output directory directly and later copy it back into the repository instead since its content does not influence anything else.
from doc-gen4.
Is it just style.css, or also the other js files that have this property?
from doc-gen4.
All of the files included the same way as style.css have this property.
from doc-gen4.
Related Issues (20)
- important type info is omitted HOT 3
- error: no such file or directory HOT 4
- ERROR: could not execute external process 'cc' HOT 2
- @[reducible] attributes are not shown HOT 1
- Hyperlinking not working when an up-arrow occurs before the declaration name
- Implement references / bibliography HOT 7
- Unclear error when running in a git repo without "origin" remote HOT 1
- Lean statement not rendered for theorems defined as `def thm : Prop := statement`
- Improve UX for long instance names HOT 1
- instances for vs instances mentioning
- Show data fields only to avoid "not rendered due to size" HOT 1
- Put inductive/structure documentation before field documentation HOT 3
- Auto-generated lemmas appear before declaration HOT 1
- De-indent comment block HOT 3
- Empty instances for HOT 1
- Escape sequences are handled incorrectly in LaTeX HOT 9
- Support for protected modifier
- auto-generated structure projections not appearing HOT 2
- noncomputable section isn't shown anywhere HOT 2
- Clicking links in the navbar or using the "Go to source" link produces an error in VS Code webviews
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from doc-gen4.