search

AI4OPT / OPFGenerator

Instance generator for OPF problems
MIT License
2 stars 3 forks source link

Add starter Manual and Reference sections to the docs #104

Closed mtanneau closed 3 months ago

mtanneau commented 3 months ago

To check this locally:

julia --project=docs -e 'using Pkg; Pkg.develop(path="."); Pkg.instantiate(); include("docs/make.jl");'

Then render the docs/build/index.html to browse the documentation locally.

mtanneau commented 3 months ago

I tried rendering the built documentation in a browser (I simply opened index.html with a browser) and tried clicking on the buttons on the navigation bar on the left. They don't seem to take me to the proper pages. Is this normal?

I checked locally and all the links seemed to work on my end. I do not know whether your issue is coming for broken links in the docs itself, or it was an issue with the fact that the docs was rendered locally.

I added a push_preview=true argument to deploydocs, which will allow to preview the documentation for ongoing PRs. This should help diagnose such issues in the future.

I'll merge this PR now; if you see any link that's broken, please open an issue and I'll fix them promptly.