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.

Sign up for GitHub

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

Jump to bottom

Sphinx docs #115

Closed
wants to merge 15 commits into from
Closed

Sphinx docs #115

wants to merge 15 commits into from

Conversation

sfmig
Copy link
Contributor

@sfmig sfmig commented Jul 25, 2023 •
edited by ruaridhg
Loading

  • Basic sphinx docs directory layout with themes
  • Add Sphinx docs to cookiecutter template folder
  • Add extensions to conf.py
  • Hardcoded copyright number (see Copyright hardcoded as 2023 in sphinx docs #191 )
  • Automatic documentation generation from code
  • Doc generation via workflow/PR
  • Add instructions

Closes #16

@sfmig sfmig marked this pull request as ready for review October 24, 2023 11:50
@paddyroddy paddyroddy mentioned this pull request Oct 24, 2023
Closed
@paddyroddy
Copy link
Member

We should add CI for users too to just make the docs

@paddyroddy paddyroddy mentioned this pull request Oct 24, 2023
Closed
@paddyroddy
Copy link
Member

Have modified to incorporate the changes in #197 (tests passing)

@samcunliffe
Copy link
Member

Is this still WIP?

@sfmig
Copy link
Contributor Author

sfmig commented Jan 23, 2024

💀

@sfmig sfmig closed this Jan 23, 2024
@paddyroddy paddyroddy deleted the sphinx-docs branch January 23, 2024 17:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Add documentation
3 participants
@sfmig @paddyroddy @samcunliffe