Where communities thrive

  • Join over 1.5M+ people
  • Join over 100K+ communities
  • Free without limits
  • Create your own community
    mortenpi thanks for the file, it actually looks like it might be a bug in the Markdown parser
    mortenpi but just FYI, you can't unfortunately include a file file that in a Documenter build since it contains HTML and the Markdown parser we have can't handle HTML
    mortenpi and it seems that the parsing problems comes from some strange interpretation of that HTML
    mortenpi and it seems that the parsing problem comes from some strange interpretation of that HTML
    mortenpi one option would also be to customize the nbconvert plugin that does NB -> Markdown to put HTML at-raw blocks around the HTML output
    Ronny Bergmann
    Good eventing. I would like to switch with my package to the travis job-way of building the documentation (as you do here https://github.com/JuliaDocs/Documenter.jl/blob/master/.travis.yml ) but enabling that disables sending the code-coverage (with the message after_success skipped as configures). As far as I can see, my config is completely similar to the one I just linked. What did I miss in changing the config? Just running tests and doc as scripts works.
    Ronny Bergmann
    I also added the coverage folder with its config, but I might be missing travis environment variables? Is there a docu for that? None of the examples I could find seem to work on my project (a not yet registered package, but I hope to submit that soon).
    Hey Morten... I have a new set of issues...
    I am trying to get my Doc deployed... even setup the runtests.jl but I get the follow ing error when I run the Make.jl file
    ┌ Info: Deployment criteria:
    │ - ✔ ENV["TRAVIS_REPO_SLUG"]="" occurs in repo="github.com/etorkia/MCHammer.jl.git"
    │ - ✘ ENV["TRAVIS_PULL_REQUEST"]="" is "false"
    │ - ✔ ENV["TRAVIS_TAG"]="" is (i) empty or (ii) a valid VersionNumber
    │ - ✘ ENV["TRAVIS_BRANCH"]="" matches devbranch="master" (if tag is empty)
    │ - ✘ ENV["DOCUMENTER_KEY"] exists
    │ - ✔ ENV["TRAVIS_EVENT_TYPE"]="" is not "cron"
    └ Deploying: ✘
    All the variable are set in Travis... I even needed to update the DocumenterTools to make it work with Windows... because there is no which command... Ill create a branh this week and push my fix. In the mean time, when I trigger the job from Travis...it also breaks. Any ideas?
    Here is the error I get in Travis
    Executing the default test script
    $ export JL_PKG=MCHammer
    Package name determined from repository url to be MCHammer
    9.23s$ julia --color=yes -e "if VERSION < v\"0.7.0-DEV.5183\"; Pkg.clone(pwd()); Pkg.build(\"${JL_PKG}\"); else using Pkg; if VERSION >= v\"1.1.0-rc1\"; Pkg.build(verbose=true); else Pkg.build(); end; end"
    Cloning default registries into ~/.julia
    Cloning registry from "https://github.com/JuliaRegistries/General.git"
    Added registry General to ~/.julia/registries/General
    ERROR: Package TOML [9d418dce-91a8-11e8-0173-7b01a971d501] not found in a registry.
    [1] pkgerror(::String) at /buildworker/worker/package_linux64/build/usr/share/julia/stdlib/v1.3/Pkg/src/Types.jl:112
    [2] check_registered(::Pkg.Types.Context, ::Array{Pkg.Types.PackageSpec,1}) at /buildworker/worker/package_linux64/build/usr/share/julia/stdlib/v1.3/Pkg/src/Operations.jl:924
    [3] #instantiate#81(::Nothing, ::Bool, ::Base.Iterators.Pairs{Union{},Union{},Tuple{},NamedTuple{(),Tuple{}}}, ::typeof(Pkg.API.instantiate), ::Pkg.Types.Context) at /buildworker/worker/package_linux64/build/usr/share/julia/stdlib/v1.3/Pkg/src/API.jl:473
    [4] instantiate at /buildworker/worker/package_linux64/build/usr/share/julia/stdlib/v1.3/Pkg/src/API.jl:461 [inlined]
    [5] build(::Pkg.Types.Context, ::Array{Pkg.Types.PackageSpec,1}, ::Bool) at /buildworker/worker/package_linux64/build/usr/share/julia/stdlib/v1.3/Pkg/src/Operations.jl:710
    [6] #build#73(::Bool, ::Base.Iterators.Pairs{Union{},Union{},Tuple{},NamedTuple{(),Tuple{}}}, ::typeof(Pkg.API.build), ::Pkg.Types.Context, ::Array{Pkg.Types.PackageSpec,1}) at /buildworker/worker/package_linux64/build/usr/share/julia/stdlib/v1.3/Pkg/src/API.jl:399
    [7] #build at ./none:0 [inlined]
    [8] #build#72 at /buildworker/worker/package_linux64/build/usr/share/julia/stdlib/v1.3/Pkg/src/API.jl:380 [inlined]
    [9] #build at ./none:0 [inlined]
    [10] #build#69 at /buildworker/worker/package_linux64/build/usr/share/julia/stdlib/v1.3/Pkg/src/API.jl:377 [inlined]
    [11] (::getfield(Pkg.API, Symbol("#kw##build")))(::NamedTuple{(:verbose,),Tuple{Bool}}, ::typeof(Pkg.API.build)) at ./none:0
    [12] top-level scope at none:1
    The command "julia --color=yes -e "if VERSION < v\"0.7.0-DEV.5183\"; Pkg.clone(pwd()); Pkg.build(\"${JL_PKG}\"); else using Pkg; if VERSION >= v\"1.1.0-rc1\"; Pkg.build(verbose=true); else Pkg.build(); end; end"" failed and exited with 1 during .
    Your build has been stopped.
    Ok... I had tried deleting the Manifest.toml and it did not work... but now I think it was a depricated Manifest file that was causing all the issues.
    i do not know anything to start writing documentation for my codes. what should i do?
    Benoît Legat
    Before each functions, you should but comments between triple quotes
        f(a, b)
    Return the sum of `a` and `b`.
    function f(a, b)
        return a + b
    Morten Piibeleht
    @fatemehmehrabi You might want to also read
    Marcelo Forets
    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/
    Christian Schilling
    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
    Marcelo Forets
    Morten Piibeleht
    @schillic @mforets As far as I know, Travis is migrating things to the .com domain, so new open source repos are there as well now. But so far they are keeping the old repos still at .org.
    But you'd have to add keys for each repo separately anyway, right?
    Marcelo Forets
    The fact that there was a JuliaReach profile in travis.com and another one in travis.org messed things up
    Marcelo Forets

    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

    Casey Kneale
    Anyone a wizard with Documenter.jl? I have somehow borked my entire Docs
    I think it may be because I ran Pkg.update and got a new version of it or something?
    Casey Kneale
    Anyone know/have alternatives to Documenter.jl?
    Morten Piibeleht
    what error are you getting?
    Casey Kneale
    something about DOCUMENTER_KEY
    Júlio Hoffimann
    How to cross-reference a page? I tried [Page Title](@ref) without success. In this case Page Title is the name of the page in the make.jl file.
    Yuri Elias Rodrigues
    Hello, I posted a difficulty I am having with DocStringExtensions, I hope my doubt is clear enough
    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.
    The repo is here: https://github.com/clu2stanford/DateUtils.jl. Why aren't the docstrings showing?
    Clark C. Evans
    Hi. For various projects I'm on, I've always wanted 2-column layout... ie for comparisons, macro vs non-macro form, etc.
    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?
    Clark C. Evans
    @mortenpi:matrix.org -- so it'd be great if it was responsive, people do read documentation on an iPhone, and in that case, tables are less than useful.
    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.
    Joey Huchette

    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 stringof the SSH private key. You may need to re-generate the keys with DocumenterTools.
    └ @ Documenter ~/.julia/packages/Documenter/FuXcO/src/Documenter.jl:554

    I'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