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

Create Documentation Website #26

Open
AFg6K7h4fhy2 opened this issue Oct 18, 2024 · 1 comment
Open

Create Documentation Website #26

AFg6K7h4fhy2 opened this issue Oct 18, 2024 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation Low Priority website Pertaining to a website associated with the code-base.

Comments

@AFg6K7h4fhy2
Copy link
Collaborator

AFg6K7h4fhy2 commented Oct 18, 2024

The repository pyrenew (see here for repository and here for rendered site) uses Sphinx documentation.

Given the accumulated technical wisdom here, I believe it seems that Sphinx makes most sense for forecasttools-py documentation. However, for some reason or another, it may also make sense to use other options, including

  • Read the docs (see here).
  • MkDocs (see here).
@AFg6K7h4fhy2 AFg6K7h4fhy2 added the documentation Improvements or additions to documentation label Oct 18, 2024
@AFg6K7h4fhy2 AFg6K7h4fhy2 added this to the [October 14, October 25] milestone Oct 18, 2024
@AFg6K7h4fhy2 AFg6K7h4fhy2 self-assigned this Oct 18, 2024
@AFg6K7h4fhy2 AFg6K7h4fhy2 added the website Pertaining to a website associated with the code-base. label Oct 21, 2024
@AFg6K7h4fhy2
Copy link
Collaborator Author

A comment from DHM might be useful here. This repo. is small enough that a Sphinx alternative might be able to be easily employed / experimented with.

Deferring to DHM on use of Sphinx or alternative. A different approach could be "TM, just make a site that works" and TM can experiment.

@dylanhmorris

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation Low Priority website Pertaining to a website associated with the code-base.
Projects
None yet
Development

No branches or pull requests

1 participant