@fatemehmehrabi You might want to also read
- This about docstrings etc.: https://docs.julialang.org/en/v1/manual/documentation/
- This, if you are not familiar with it, about the Markdown syntax used in docstrings and manual pages: https://docs.julialang.org/en/v1/stdlib/Markdown/
- Once you have some basic docs down, you can look at Documenter to see how to build a manual: https://juliadocs.github.io/Documenter.jl/stable/man/guide/
- And you can also look at Example.jl -- it has a basic documentation example too: https://github.com/JuliaLang/Example.jl
Hi! When trying to host the documentation for a new package (https://github.com/JuliaReach/RangeEnclosures.jl/) we are getting this error:
Setting environment variables from repository settings
$ export DOCUMENTER_KEY=[secure]
We were unable to parse one of your secure environment variables.
Please make sure to escape special characters such as ' ' (white space) and $ (dollar symbol) with \ (backslash) .
For example, thi$isanexample would be typed as thi\$isanexample. See https://docs.travis-ci.com/user/encryption-keys.
did you get this error recently or have a suggestion for solving it? i generated the keys as in https://juliadocs.github.io/Documenter.jl/dev/man/hosting/
hi, i work with @mforets and we managed to resolve the problem
for some reason, we have two profiles at Travis: one containing all repositories of our organization with a .org address here and one containing new repositories with a .com address here (the latter seems to be not public). we only tried to add the private key to the latter (the .com address), which did not work. adding it to the former (the .org address) worked
for some reason, we have two profiles at Travis: one containing all repositories of our organization with a .org address here and one containing new repositories with a .com address here (the latter seems to be not public). we only tried to add the private key to the latter (the .com address), which did not work. adding it to the former (the .org address) worked
But you'd have to add keys for each repo separately anyway, right?
But you'd have to add keys for each repo separately anyway, right?
hmm the new github repo has only 1 deploy key. i think we just kept with https://travis-ci.org
I think it may be because I ran Pkg.update and got a new version of it or something?
someone can help me?
Hi, I've been trying to document a repo but the docstrings aren't showing. I included the
@docs
yyyymmdd2yyyy(d) in the index.md file and exported the functions in the module.
It seems some people are using raw in HTML in order to add this sort of feature. Would it be possible to have a convenient way (that doesn't litter HTML tags everywhere) in the markup processed by Documenter; so, some sort of plugin /w syntax markers that let me easily use two columns.
@clarkevans: Markdown doesn't really have any syntax for this, so first one would have invent something that would also work with the parser in the Markdown stdlib (would probably have to rely on some custom at-blocks). Once you have that, in principle, generating the necessary HTML wouldn't be that difficult.
That said, would it be possible to use tables?
I think a table is a stopgap, but it'd be great if Documenter had a set of built-in macros for a 2-column layout that could be integrated with the CSS styling of the page. Mostly what I want to do is compare two code blocks with each other. For example,
DataFrames.jl vs Query.jl differences. Or for DataKnots, a macro form (very readable, but not Julia) and a non-macro form (raw Julia). Having these side-by-side is really important to facilitate comparisons and to not have the user distracted by contextual switching.
Hi all, I'm trying to deploy docs for a new package (https://github.com/joehuchette/Justitia.jl) and am running into some problems. I'm using a Github workflow, generated my two keys using DocumenterTools.genkeys, and then set them correctly in the Github repo (I think). But, when the workflow runs, it appears to crash pretty early in the deploy stage with:
Initialized empty Git repository in /tmp/jl_mYkDJ1/.git/
Failed to add the RSA host key for IP address 'XXX.XX.XXX.X' to the list of known hosts (/home/runner/.ssh/known_hosts).
Load key "/home/runner/work/Justitia.jl/Justitia.jl/docs/.documenter": invalid format
git@github.com: Permission denied (publickey).
fatal: Could not read from remote repository.
Please make sure you have the correct access rights
and the repository exists.
┌ Error: Git failed to fetch git@github.com:joehuchette/Justitia.jl.git
│ This can be caused by a DOCUMENTER_KEY variable that is not correctly set up.
│ Make sure that the environment variable is properly set up as a Base64-encoded string
│ of the SSH private key. You may need to re-generate the keys with DocumenterTools.
└ @ Documenter ~/.julia/packages/Documenter/FuXcO/src/Documenter.jl:554I've reset the keys a few times but I get the same failure. Am I missing something silly here? My best guess is that the public key I'm setting in "step 1" of uploading the keys, but I'm just copy-pasting the key right from the output of genkeys. Thanks in advance!
*the public key is malformed
I know its a bit of a weird question but I think the documentation style is very clear and clean so I'd love to be able to use it for non-Julia stuff
For the use in Python: in principle there's nothing stopping you from using Documenter as a simple static site generator. But, of course, you wouldn't get any of the neat things like the evaluation of code snippets, integration with docstrings etc. And you'd still have to run it via Julia.
$ julia --project=docs docs/make.jl
[ Info: SetupBuildDirectory: setting up build directory.
ERROR: LoadError: '../NEWS.md' is not an existing page!
@micahjsmith: you can copy it over to
docs/src before the makedocs call
Is it possible to deploy to another repo ?
That is I generate the doc for repo /A and want to deploy it in repo /B
(using also an orphan gh-pages branch, and if possible a different root path)
That is I generate the doc for repo /A and want to deploy it in repo /B
(using also an orphan gh-pages branch, and if possible a different root path)
Purpose: to consolidate the docs of a set of repo into a single one.
(deploydocs seems to explicitly checks that ENV["GITHUB_REPOSITORY"] occurs in its
repo arg. This is unfortunate...
Found partial answer in : [https://discourse.julialang.org/t/deploying-docs-to-another-repo-with-github-actions/64459]