# \#documenterjl

**URL:** https://discourse.julialang.org/tag/documenterjl/1337.md

[Latest](https://discourse.julialang.org/latest.md) · [Categories](https://discourse.julialang.org/categories.md) · [Tags](https://discourse.julialang.org/tags.md)

---

## [Documenter.jl says \`git remote\` failed - why?](https://discourse.julialang.org/t/documenter-jl-says-git-remote-failed-why/135142)

<div class="topic-metadata">

**Author:** [@floswald](https://discourse.julialang.org/u/floswald)\
**Replies:** 9\
**Last updated:** [January 19, 2026, 8:49pm UTC](https://discourse.julialang.org/t/documenter-jl-says-git-remote-failed-why/135142 "2026-01-19T20:49:48Z")

</div>

I don’t understand this error reported by Documenter.jl - in particular, why is Documenter prefixing my PATH with the strange artifact? why: floswald@PTL11077 ~/.j/d/P/docs (main)\> /Users/floswald/.julia/artifacts/9a049…

---

## [Simple diagrams in docs](https://discourse.julialang.org/t/simple-diagrams-in-docs/131884)

<div class="topic-metadata">

**Author:** [@Tamas\_Papp](https://discourse.julialang.org/u/Tamas_Papp)\
**Replies:** 7\
**Last updated:** [August 28, 2025, 11:32am UTC](https://discourse.julialang.org/t/simple-diagrams-in-docs/131884 "2025-08-28T11:32:47Z")

</div>

I would like to include a simple diagram (= boxes connected by arrows) in the docs of a Julia package, generated by Documenter.jl as usual. I am not sure what my best option is. I can just write it in whatever markup I…

---

## [How does Documenter.jl import the parent package?](https://discourse.julialang.org/t/how-does-documenter-jl-import-the-parent-package/128387)

<div class="topic-metadata">

**Author:** [@co1emi11er](https://discourse.julialang.org/u/co1emi11er)\
**Replies:** 4\
**Last updated:** [April 25, 2025, 6:49am UTC](https://discourse.julialang.org/t/how-does-documenter-jl-import-the-parent-package/128387 "2025-04-25T06:49:44Z")

</div>

I am writing documentation for my package AISCSteel.jl. I am wanting to use my other package Handcalcs.jl to show some of the steps in the documentation. There is one limitation to Handcalcs.jl and that is that it will …

---

## [Getting warning generated HTML from md file is too big](https://discourse.julialang.org/t/getting-warning-generated-html-from-md-file-is-too-big/128348)

<div class="topic-metadata">

**Author:** [@co1emi11er](https://discourse.julialang.org/u/co1emi11er)\
**Replies:** 3\
**Last updated:** [April 24, 2025, 6:43am UTC](https://discourse.julialang.org/t/getting-warning-generated-html-from-md-file-is-too-big/128348 "2025-04-24T06:43:33Z")

</div>

I am getting the following warning about two of my md files in my docs. julia\> servedocs() \[ Info: SetupBuildDirectory: setting up build directory. \[ Info: Doctest: running doctests. \[ Info: ExpandTemplates: expanding m…

---

## [Documenter.jl not including any definitions and then complaining that they're missing](https://discourse.julialang.org/t/documenter-jl-not-including-any-definitions-and-then-complaining-that-theyre-missing/124644)

<div class="topic-metadata">

**Author:** [@Mark\_Nahabedian](https://discourse.julialang.org/u/Mark_Nahabedian)\
**Replies:** 1\
**Last updated:** [February 18, 2025, 3:34pm UTC](https://discourse.julialang.org/t/documenter-jl-not-including-any-definitions-and-then-complaining-that-theyre-missing/124644 "2025-02-18T15:34:00Z")

</div>

One of my projects, GitHub - MarkNahabedian/Rete.jl: An inplementation of the Rete knowledge based system shell., is failing its documentation build both in its CI GitHub action and locally. This documentetion used to…

---

## [Learning to write and rendering Julia-style Markdown](https://discourse.julialang.org/t/learning-to-write-and-rendering-julia-style-markdown/123243)

<div class="topic-metadata">

**Author:** [@Benny](https://discourse.julialang.org/u/Benny)\
**Replies:** 8\
**Last updated:** [December 3, 2024, 6:54am UTC](https://discourse.julialang.org/t/learning-to-write-and-rendering-julia-style-markdown/123243 "2024-12-03T06:54:42Z")

</div>

Getting around to learning how to write documentation more sophisticated than ASCII docstrings, so I’m practicing Markdown. VS Code already previews/renders Markdown files with LaTeX equation support, so that’s cool. Thi…

---

## [Documenter.jl pages aren't being updated](https://discourse.julialang.org/t/documenter-jl-pages-arent-being-updated/119108)

<div class="topic-metadata">

**Author:** [@ilkerarslan](https://discourse.julialang.org/u/ilkerarslan)\
**Replies:** 4\
**Last updated:** [September 6, 2024, 1:09pm UTC](https://discourse.julialang.org/t/documenter-jl-pages-arent-being-updated/119108 "2024-09-06T13:09:42Z")

</div>

Hi everyone. I am writing documentation for the package I am developing. After some point the changes I am making aren’t loaded to github pages stable version altough they are reflected in the /dev/ link. I can see the…

---

## [Stripping dollar signs from equations in Documenter.jl](https://discourse.julialang.org/t/stripping-dollar-signs-from-equations-in-documenter-jl/113503)

<div class="topic-metadata">

**Author:** [@Walter\_Dal\_Maz\_Silva](https://discourse.julialang.org/u/Walter_Dal_Maz_Silva)\
**Replies:** 1\
**Last updated:** [April 30, 2024, 8:05pm UTC](https://discourse.julialang.org/t/stripping-dollar-signs-from-equations-in-documenter-jl/113503 "2024-04-30T20:05:45Z")

</div>

First post here, and I don’t ask many questions in forums cause most of the time I find what I am looking for somewhere, but now I am stuck and couldn’t find a suitable solution in another topics. I’ve been using Julia d…

---

## [Documenter.jl - Creating Documentation for Arbitrary Julia Scripts](https://discourse.julialang.org/t/documenter-jl-creating-documentation-for-arbitrary-julia-scripts/108038)

<div class="topic-metadata">

**Author:** [@General.T.Case](https://discourse.julialang.org/u/General.T.Case)\
**Replies:** 1\
**Last updated:** [December 26, 2023, 6:37am UTC](https://discourse.julialang.org/t/documenter-jl-creating-documentation-for-arbitrary-julia-scripts/108038 "2023-12-26T06:37:07Z")

</div>

Is it possible to use Documenter.jl to create documentation for an arbitrary set of Julia scripts located in arbitrary directories? In particular, suppose the scripts are not part of package. It seems straightforward e…

---

## [Documenter.jl expects my local project to be registered](https://discourse.julialang.org/t/documenter-jl-expects-my-local-project-to-be-registered/101437)

<div class="topic-metadata">

**Author:** [@kapple](https://discourse.julialang.org/u/kapple)\
**Replies:** 4\
**Last updated:** [July 11, 2023, 2:35am UTC](https://discourse.julialang.org/t/documenter-jl-expects-my-local-project-to-be-registered/101437 "2023-07-11T02:35:20Z")

</div>

I have a local project, say MyProject. It has a docs directory with its own Project.toml file, which contains \[deps\] Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4" MyProject = "\<UUID\>" Plots = "91a5bcdd-55d7-5caf-…

---

## [Fail to deploy from Documenter to GITHUB](https://discourse.julialang.org/t/fail-to-deploy-from-documenter-to-github/98021)

<div class="topic-metadata">

**Author:** [@Philippe\_Maincon1](https://discourse.julialang.org/u/Philippe_Maincon1)\
**Replies:** 14\
**Last updated:** [April 28, 2023, 10:44am UTC](https://discourse.julialang.org/t/fail-to-deploy-from-documenter-to-github/98021 "2023-04-28T10:44:09Z")

</div>

I am working on Muscade.jl (work in progress!), and I have a first incomplete documentation I wish to deploy. Everything works fine… except I get a 404. Here is the dump: My repo structure includes Muscade docs …