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

Add sphinx #2

Merged
merged 25 commits into from
Feb 7, 2023
Merged

Add sphinx #2

merged 25 commits into from
Feb 7, 2023

Conversation

ItsDrike
Copy link
Member

@ItsDrike ItsDrike commented Dec 15, 2022 •
edited
Loading

What this PR aims to add:

  • README badge linking to our readthedocs)
  • Sphinx dependency
  • (Mostly) blank general file structure for the docs
    • This PR will NOT include full text to all of the individual documentation pages, it's purely here to add sphinx as a dependency and provide some general layout for the docs, which can then be finished in other PRs.
  • Taskipy alias(es) for building the docs pages locally

This PR is a part of #19.

@ItsDrike ItsDrike added a: documentation Related to project's documentation (comments, docstrings, docs) p: 1 - high This should be addressed quickly t: feature New request or feature labels Dec 15, 2022
@ItsDrike ItsDrike changed the title Add docs badge to README Add docs Dec 15, 2022
@ItsDrike ItsDrike added this to the 1.0.0 milestone Dec 17, 2022
@ItsDrike ItsDrike mentioned this pull request Jan 13, 2023
Merged
2 tasks
@ItsDrike ItsDrike changed the title Add docs Add sphinx Jan 13, 2023
@ItsDrike ItsDrike mentioned this pull request Jan 13, 2023
Open
23 tasks
@ItsDrike ItsDrike force-pushed the add-docs branch 2 times, most recently from db8663e to 627cac2 Compare February 7, 2023 09:46
@ItsDrike ItsDrike force-pushed the add-docs branch 3 times, most recently from c53c67b to 31c1b37 Compare February 7, 2023 10:36
@ItsDrike ItsDrike force-pushed the add-docs branch 2 times, most recently from 9e7e7d6 to f0e142f Compare February 7, 2023 11:34
@ItsDrike ItsDrike marked this pull request as ready for review February 7, 2023 20:32
@ItsDrike ItsDrike merged commit 84e68ac into main Feb 7, 2023
@ItsDrike ItsDrike deleted the add-docs branch February 7, 2023 20:35
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
a: documentation Related to project's documentation (comments, docstrings, docs) p: 1 - high This should be addressed quickly t: feature New request or feature
Projects
None yet
Milestone
1.0.0
Development

Successfully merging this pull request may close these issues.
1 participant
@ItsDrike