Attempt at documenter #71
Conversation
| # "Examples" => examples, | ||
| "Function References" => "reference.md", | ||
| ] | ||
| ) | ||
|
|
||
| # examples_cb() | ||
|
|
||
| deploydocs(repo = "github.com/JeffFessler/MIRT.jl") | ||
| deploydocs(repo = "github.com/JeffFessler/MIRT.jl") |
There was a problem hiding this comment.
I have run julia make.jl locally to try to generate html documentation and it runs locally but you put /docs/build into .gitignore so it doesn't end up on github.
This is a no-op when we run it locally, and will push to gh-pages branch if it's running on a CI environment, e.g., Github Actions. See also: https://juliadocs.github.io/Documenter.jl/dev/man/hosting/#.gitignore
I'm really sorry that I haven't found some time to add the demos here, I was way too exhausted these days in a day-to-day seminar. My limited time for Julia is spent on setting up storage mirror servers, e.g., SJTUG and BFSU so that users in China can add packages without much trouble; they are broken these days and I spent a lot of time on debugging and enhancing the tool.
Codecov Report
@@ Coverage Diff @@
## master #71 +/- ##
=======================================
Coverage 99.76% 99.76%
=======================================
Files 49 49
Lines 2113 2113
=======================================
Hits 2108 2108
Misses 5 5
Continue to review full report at Codecov.
|
|
Well, I'm going to merge this now and hope that it triggers a real doc build... |
|
@johnnychen94 ok, i see some stuff in the gh-pages branch now, and i configured the settings for MIRT.jl to enable github pages and the settings says "your site is published at" https://jefffessler.github.io/MIRT.jl/ but i'm not seeing anything there. Maybe I need to try another push to trigger it now that I have the github.io set up. |
|
It's https://jefffessler.github.io/MIRT.jl/dev/ for dev docs and https://jefffessler.github.io/MIRT.jl/stable for versioned docs (not yet existed). |
@johnnychen94 I have run
julia make.jllocally to try to generate html documentation and it runs locally but you put/docs/buildinto.gitignoreso it doesn't end up on github. In the process I found many docstrings that needed fixing so this PR is mostly about that, but it would be nice now to see if we can get this very limited initial documentation working online.