Did you just start making an amazing package and want to document it? Failing miserably? I was in your shoes a few days back and after a lot of drama I managed to get everything running. So I thought I would write a step by step tutorial on how to use Documenter.jl . POST Hopefully it will help you…

It might be a good idea to show how to set up TagBot to automatically push docs for stable versions as well. You need to add SSH keys for that, as described here: Hosting Documentation · Documenter.jl

Thank you. I will add that part to the tutorial too :slight_smile:

I like this in that it’s more compact than what we have in the official manual. Just to put it out there: we’re always happy to take PRs for to make Documenter’s official documentation more accessible for new users :wink: Just a few comments: PkgTemplates can actually generate Documenter configu…

Well you have an awesome documentation but I thought it would be nice to put it in a workflow of sorts for people new to Julia. :slight_smile: To be very honest I did not know these points myself. Thank you! Haha let me fix these changes that you mentioned in the post and maybe I’ll drop a PR wit…

[image] SubhadityaMukherjee: Haha let me fix these changes that you mentioned in the post and maybe I’ll drop a PR with this on the official documentation. Is that okay? This could work well as a quickstart section (the Guide page is a bit verbose, and only covers part of what’s needed for a …

Ah I got caught up with some work but finally got around to sending a PR. And I added it as an internal resource and not as a link. :slight_smile: Here is the PR. Link @mortenpi

[image] mortenpi: Hosting things under the docs/ directory on the master branch is not recommended. Instead, it’s better to put the generated content onto a separate gh-pages branch and host from there. Can someone provide a step-by-step commands of what that means? Currently I have one proje…

[image] lmiq: got lost in the path. Please keep in mind that [image] mortenpi: PkgTemplates can actually generate Documenter configuration for you .

[image] Tamas_Papp: Please keep in mind that Before I do something stupid, is it safe to use package templates in a project already half setup? Will it overwrite the files I have already in place? (of course, if it does, I can get them back from the repository).

Commit everything to the git repo first, then you can cherry-pick the changes suggested by the template generator.

Step by Step Documentation Tutorial

Community

SubhadityaMukherjee September 5, 2020, 12:26pm 4

Thank you. I will add that part to the tutorial too

Topic		Replies	Views
Deploying documentation with Documenter (automatically with each new push to the repo) General Usage package , documentation	25	3937	April 25, 2024
Using Documenter.jl General Usage	6	1460	December 23, 2016
Documenting packages General Usage question	8	563	February 13, 2023
Adding Documentation to a GitHub Repository Tooling	4	796	May 29, 2020
Docstrings do not appear in the project documentation New to Julia documentation , documenter	18	856	April 15, 2023

Step by Step Documentation Tutorial

Related topics