Documentation #159
Documentation #159
Conversation
|
Hey, I've added the gh action for documentation; I'm not an expert though I just copied it from a different project that I created documentation for a long time ago ;) |
It is still very much work in progress.
Joel-Dahne
force-pushed
the
documentation
branch
from
112c1f0
to
7b5defd
Compare
|
The main issue now is warnings for missing docs and cross references. Missing docs is not really a problem. Bit I haven't figure out how to handle the cross references. For example we reference |
It is not possible to link to a method outside of the documented package. See e.g In this regard rust generated docs are so much better... |
Documenter.jl can't handle link to documentations outside of the package.
|
I have now removed some cross references and added the required documentation for some others. The only warnings remaining are for docs not included in the documentation, but these are mostly internal functions and I don't think it makes much sense to include them. I also added documentation for the With this I think the documentation is "done". The most important parts are there, but it could certainly benefit from improvements at a later stage. The next step would be to actually deploy the documentation and link to it in the README. I'll see if I can figure out how that works! |
This is added as a development dependency by the github workflow.
|
Okay, I think this might be ready now! We'll only really know if it works until we deploy it though... |
|
@kalmarek Could you approve this PR as well? Then I'll merge this and rebase the other one on this. |
|
@Joel-Dahne Sorry it took me so long; I'm traveling right now ;) |
|
No worries at all! Lets hope that this works now! |
I have been thinking about improving the state of the documentation for a while now. This is still very much work in progress but at least a starting point.
To run it locally you can follow the instructions from Documenter.jl. I do the following (I write it down mostly so I don't forget until next time): start a Julia REPL and activate the
Arblib.jlrepository, then runinclude("docs/make.jl"). I then run a local web server withpython3 -m http.server --bind localhost.It is the first time I create documentation for a Julia package and I have yet to figure out how to e.g. setup GitHub to build the documentation and such.
Any comments or ideas for the documentation are appreciated! I just wanted to get something started to have something to build on.