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

Documentation on readthedocs.io #42

Open
lemmih opened this issue Nov 10, 2020 · 2 comments
Open

Documentation on readthedocs.io #42

lemmih opened this issue Nov 10, 2020 · 2 comments

Comments

@lemmih
Copy link
Collaborator

lemmih commented Nov 10, 2020

readthedocs.io hosts documentation written in markdown for free. I think it would be a good fit for documentation that goes beyond haddock.

@noinia I can configure it with github hooks if you add me as a collaborator.

@noinia
Copy link
Owner

noinia commented Nov 15, 2020

I don't think we really have such documentation at this point right? Or do you have a particular "part" of hgeometry in mind that specifically needs this kind of documentation? Clearly, having more documentation is certainly welcome, but my preference would be to have it as tightly integrated with the package and its builds as possible, so to make sure things don't go out of sync.

@lemmih
Copy link
Collaborator Author

lemmih commented Nov 19, 2020

We don't have any such documentation right now but I'd like to write some. Tutorials and how-to guides could be part of the haddock docs but I would prefer to keep them separate, especially if they are full of pictures.

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

No branches or pull requests

2 participants