Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Rendering of docs #37

Open
tomjemmett opened this issue Feb 23, 2023 · 3 comments
Open

Rendering of docs #37

tomjemmett opened this issue Feb 23, 2023 · 3 comments
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request must

Comments

@tomjemmett
Copy link
Member

Currently, the doc's folder contains files to generate documentation files using sphinx. However, these are not built automatically. The current process is to run

cd docs
make html

This could be tied to a github action to generate automatically and deployed to GitHub pages.

@tomjemmett
Copy link
Member Author

see also #36

@tomjemmett tomjemmett added the enhancement New feature or request label Feb 23, 2023
@tomjemmett tomjemmett self-assigned this Feb 23, 2023
@tomjemmett
Copy link
Member Author

temporarily removed sphinx in the branch dockerise - something is broken with the package. may be a good opportunity to look at alternative

@ChrisBeeley
Copy link
Member

MKdocs!

@ChrisBeeley ChrisBeeley added this to the 0.3.0 milestone Apr 12, 2023
@tomjemmett tomjemmett modified the milestones: 0.3.0, 0.4.0 May 22, 2023
@ChrisBeeley ChrisBeeley modified the milestones: 0.4.0, 0.6 Oct 31, 2023
@ChrisBeeley ChrisBeeley assigned yiwen-h and unassigned tomjemmett Nov 1, 2023
@ChrisBeeley ChrisBeeley removed this from the 0.6 milestone Nov 2, 2023
@yiwen-h yiwen-h added documentation Improvements or additions to documentation must labels May 24, 2024
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request must
Projects
None yet
Development

No branches or pull requests

3 participants