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

Update read-the-docs documentation #758

Open
6 of 10 tasks
ClaraBuettner opened this issue Aug 15, 2024 · 0 comments
Open
6 of 10 tasks

Update read-the-docs documentation #758

ClaraBuettner opened this issue Aug 15, 2024 · 0 comments
Assignees

Comments

@ClaraBuettner
Copy link
Contributor

ClaraBuettner commented Aug 15, 2024

The read the docs description will be extended in preparation of the next release.

Planned changes:

  • adapt structure to new file structure (K)
  • add publications (K)
  • check and update existing texts and explanations (K)
  • write 'Contributing' chapter (K)
  • check installation description (C)
  • document new consecutive method (C)
  • document 'What's new' (C)
  • refer to modules (K)
  • include more references (K)
  • We could also think of finally including the gurobi solver option documentation (Gurobi SolverOptions documentation #213) in the rtd (K)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants