ex_doc
ex_doc copied to clipboard
ExDoc produces HTML and EPUB documentation for Elixir projects
We will probably need npm still, for handlebars, but it should streamline things considerably.
Closes #1575 This commit attempts to resolve a case where there are specs defined referring to a function called record/*
An issue was reported on rebar3_ex_doc (https://github.com/starbelly/rebar3_ex_doc/issues/26). Specifically if a function is called record and more specifically has an accompanying spec an edge is hit. I came up with a...
Closes https://github.com/elixir-lang/ex_doc/issues/1411 Closes https://github.com/elixir-lang/ex_doc/issues/1294 PR Originally published in https://github.com/elixir-lang/ex_doc/pull/1412 I'm picking this feature up from it was left off. The only thing to solve is the global state issue mentioned...
Related discussion in #1440
Unfortunately Markdown documents try to escape backslashes. Which means that a Katex formula like this: ``` $$ \begin{bmatrix} 1 & 2 \\ 3 & 4 \end{bmatrix} $$ ``` Will appear...
[old Erlang child specification](`t:supervisor.child_spec()`) will generate old Erlang child specification I find myself making this kind of mistakes, and ExDoc not warnings about it. I think if Exdoc ends up...
Is it desired to store the sidebar state in ~~`localStorage` or~~ `sessionStorage`? For me if I go into my docs "reading mode". Means I close the sidebar and read page...
- [x] Basic support - [x] Render typespecs using erl_pp/erl_prettypr - [x] Highlight erlang code examples - [x] Autolink Erlang typespecs - [x] Rewrite links. E.g. `{:a, [rel: "https://erlang.org/doc/link/seemfa", href:...
While working on improving the `make docs` command in Elixir, I accidentally discovered this bug that deleted my entire Elixir repo locally loosing all local branches. I don't know if...