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

Initial draft docs #283

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Conversation

filiplajszczak
Copy link
Contributor

As there were no docs for the project apart from the README, I have created
basic draft sphinx documentation. It is partially based on including sections
from the README, but I have also added some additional information in more
structured way.

The questions are where to host it and if the README should be kept in the
current extensive form or if it should be shortened and the rest just kept
in the docs. What is the right balance between the README and the docs?

I temporarily hosted the draft docs on PythonAnywhere so it could be quickly viewed rendered.

The choice of theme and other bikeshedding can be done later, but I think
it's a good start.

@icemac
Copy link
Contributor

icemac commented Nov 21, 2024

@filiplajszczak Hi! I really like this documentation. Thank you very much!
I'd suggest to host it on readthedocs.org and add a badge to the readme. (I can do both once the PR is merged.)

The PR is still in draft mode, what do you think is still needed to make it ready?

@filiplajszczak filiplajszczak marked this pull request as ready for review November 21, 2024 07:32
@filiplajszczak
Copy link
Contributor Author

Yeah, there is some potential extra work, but there always is. Nothing that could not happen in the next iteration. So maybe let's start with what we have without gold plating.

Wouldnl you be able to setup something with RTD and make it part of CI and release processes?

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