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

Recommend installation in docs Project.toml? #2425

Closed
nilshg opened this issue Jan 24, 2024 · 4 comments · Fixed by #2429
Closed

Recommend installation in docs Project.toml? #2425

nilshg opened this issue Jan 24, 2024 · 4 comments · Fixed by #2429

Comments

@nilshg
Copy link
Contributor

nilshg commented Jan 24, 2024

First time user so maybe this has been discussed before: I've been advised on Slack that the right way to use Documenter in my package is to do:

using MyPkg
] activate docs
] add Documenter

which creates a Project.toml file under /docs. Currently the Package Guide just says to do ]add Documenter, would it be worth changing this to reflect the docs Project workflow?

@mortenpi
Copy link
Member

Related to #2321. In general, yes, I think we expect the users to add Documenter to their local environment, likely under the docs/ directory in their package. So adding at least a small note about that would probably be good, although I feel that a good solution is to re-think the whole getting started guide.

@nilshg
Copy link
Contributor Author

nilshg commented Jan 25, 2024

Thanks - I guess it then comes down to the question of how likely is it that this rewrite happens reasonably soon? Mentioning docs/ could be a 15 minute PR which might help people immediately with quite a fundamental first step, but I also get the point about not wanting to tinker with things now if everything gets rewritten soon.

@mortenpi
Copy link
Member

There's nothing in progress right now, so adding a note right now would be good I think -- it would also act as reminder to emphasize this during the rewrite.

@nilshg
Copy link
Contributor Author

nilshg commented Jan 26, 2024

Ok. here's a first attempt:

#2429

@mortenpi mortenpi linked a pull request Jan 27, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants