Skip to content

Add Documenter docs for LabelledArrays #118

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

Merged
merged 8 commits into from
Jun 6, 2022
Merged

Add Documenter docs for LabelledArrays #118

merged 8 commits into from
Jun 6, 2022

Conversation

00krishna
Copy link
Contributor

I created the basic skeleton for the docs. The basic pieces for Documenter.jl and the github workflow Documenter.yml are created. I wanted to make sure I am on the right track before proceeding any farther.

One problem I ran into was a strange error when trying to test the development of the docs. I ran the usual code.

julia --project=docs/ docs/make.jl

But for some reason I am getting an error below. Kinda a strange error since Documenter is not imported anywhere else. Have you hit this error before? Slack #helpdesk did not turn up any clues.

WARNING: using Documenter.Documenter in module Main conflicts with an existing identifier.
ERROR: LoadError: importing Documenter into Main conflicts with an existing identifier
in expression starting at /media/hayagriva/Dropbox/sandbox/help_chris/LabelledArrays.jl/docs/make.jl:1

@ChrisRackauckas ChrisRackauckas marked this pull request as ready for review June 6, 2022 05:20
@ChrisRackauckas
Copy link
Member

Can some of this be converted to docstrings?

@00krishna
Copy link
Contributor Author

Yep, I can convert some of this to docstrings. I just wanted to make sure that the basic Documenter setup was on the right track. So I should take some of the content out of the markdown files and move it to docstrings.

I will see if I can get the CI workflow to work on my end too. That issue with importing Documenter into Main conflicts with an existing identifier prevented me from catching some of these errors before creating the PR.

@ChrisRackauckas ChrisRackauckas merged commit a286861 into SciML:master Jun 6, 2022
@ChrisRackauckas
Copy link
Member

Merging to start getting this into the doc builder system

@00krishna 00krishna deleted the add_docs_labelledarrays branch June 6, 2022 14:49
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.

2 participants