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

Remove unneeded files in docs directory #2237

Merged
merged 8 commits into from
Mar 16, 2022
Merged

Remove unneeded files in docs directory #2237

merged 8 commits into from
Mar 16, 2022

Conversation

brandenchan
Copy link
Contributor

@brandenchan brandenchan commented Feb 23, 2022 •
edited

Proposed changes:

  • Remove unneeded files that are directly in the docs folder
  • Update readme (TO DO)

@brandenchan
Copy link
Contributor Author

@PiffPaffM It is unclear to me whether we should also delete release_docs.sh, make.bat and Makefile

@brandenchan brandenchan changed the title Clean docs directory Remove unneeded files in docs directory Feb 23, 2022
@PiffPaffM
Copy link
Contributor

@brandenchan You can delete all of them.
release_docs_sh is outdated and not needed anymore for the release.
marke.bat and Makefile are old files which we used for a sphinx deployment

@ZanSara
Copy link
Contributor

ZanSara commented Feb 24, 2022

We actually have "Run release-docs.sh" as one of the steps of the release process (I've just seen yesterday with @julian-risch). Is the script doing anything special? I haven't looked into it yet

@ZanSara ZanSara added the type:documentation Improvements on the docs label Feb 24, 2022
@julian-risch
Copy link
Member

Thanks for brining this to my attention @ZanSara . If the script is going to be deleted, please also update our internal notion page "PyPi release". I am wondering though what the new process looks like then? 🤔

@PiffPaffM
Copy link
Contributor

@brandenchan Let's add release-docs.sh it again to the package. I mixed things up when I gave you the advice. @ZanSara Thanks for double-checking!

ZanSara
ZanSara approved these changes Mar 16, 2022
View reviewed changes
Copy link
Contributor

@ZanSara ZanSara left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 🙂

@brandenchan brandenchan merged commit b8a3c93 into master Mar 16, 2022
@brandenchan brandenchan deleted the clean_docs_1 branch March 16, 2022 16:37
@julian-risch julian-risch mentioned this pull request Mar 23, 2022
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ZanSara ZanSara ZanSara approved these changes

@PiffPaffM PiffPaffM Awaiting requested review from PiffPaffM

Assignees
No one assigned
Labels
type:documentation Improvements on the docs
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
4 participants
@brandenchan @PiffPaffM @ZanSara @julian-risch