Documenter.jl - Creating Documentation for Arbitrary Julia Scripts

General Usage
, , ,
1

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 enough to include references in the index.md file to the functions for which one wants to create documentation.
  • I would then have guessed that it is simply a matter of telling makedocs() in the make.jl file where to look for function definitions.

However, I have not been able to make this work. Any guidance would be greatly appreciated.

1 Like
2

Literate.jl supports generating Documenter.jl -compatible markdown files (from julia scripts). Its docs/make.jl could be a starting point.

1 Like