Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation via Documenter.jl #56

Merged
merged 4 commits into from
Sep 20, 2023

Conversation

sloede
Copy link
Contributor

@sloede sloede commented Sep 20, 2023

This partially addresses #27.

After having to navigate to the sources of Preferences.jl for the umpteenth time because I forgot the details of the non-macro API, I decided to add Documenter.jl-based documentation. In addition, I added some small bits and pieces to the docs (such as an author and license section).

@staticfloat It would be great if you could set up the DOCUMENTER_KEY secret as described in the Documenter.jl docs & review this PR at your convenience. If you want only the bare minimum docs and not the additional changes I made, I can also revert some of them.

.github/workflows/documentation.yml Outdated Show resolved Hide resolved
.github/workflows/documentation.yml Outdated Show resolved Hide resolved
@codecov
Copy link

codecov bot commented Sep 20, 2023

Codecov Report

Merging #56 (e914ecb) into master (e8082bc) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master      #56   +/-   ##
=======================================
  Coverage   88.05%   88.05%           
=======================================
  Files           2        2           
  Lines         134      134           
=======================================
  Hits          118      118           
  Misses         16       16           

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@sloede
Copy link
Contributor Author

sloede commented Sep 20, 2023

I changed the job name to build-docs since sometimes GitHub only refers to the job names without the workflow name, and in that case having only build is just very unhelpful.

@staticfloat staticfloat merged commit 72ff0a6 into JuliaPackaging:master Sep 20, 2023
19 checks passed
@staticfloat
Copy link
Member

Awesome! Let's see if it works!

@sloede sloede deleted the msl/add-documenter branch September 20, 2023 17:07
@sloede sloede mentioned this pull request Sep 20, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants