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

SNEWS CS Documentation Improvements #108

Merged
merged 13 commits into from
Aug 14, 2024
Merged

SNEWS CS Documentation Improvements #108

merged 13 commits into from
Aug 14, 2024

Conversation

KaraMelih
Copy link
Collaborator

This PR fixes the readthedocs build, restructures some of the documentation files, and removes the setuptools installation to avoid possible confusion.

This version solely depends on the poetry installation.

The documentation still needs to be improved before making the PR

@KaraMelih
Copy link
Collaborator Author

after discussing with @justinvasel I decided to bring back the setuptools installation. (so the branch name no longer makes sense, sorry.)

This PR introduces the following;

  • Clean some of the files
  • rename doc -> docs
  • add 2 more packages to poetry dependencies: sqlalchemy and tabulate
  • create requirements file from the poetry dependencies
  • separate, isolated requirements for the readthedocs under docs folder
  • improved documentation
  • added a developers page in the documentation

@KaraMelih KaraMelih marked this pull request as ready for review August 14, 2024 19:51
@KaraMelih KaraMelih requested a review from justinvasel August 14, 2024 19:51
@KaraMelih KaraMelih changed the title Poetry only SNEWS CS Documentation Improvements Aug 14, 2024
@sybenzvi sybenzvi merged commit 30ec886 into main Aug 14, 2024
@sybenzvi sybenzvi deleted the poetry_only branch August 14, 2024 21:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants