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

Make docs build process less obscure #1374

Merged
merged 2 commits into from
Jun 21, 2021

Conversation

mathbunnyru
Copy link
Member

No description provided.

@@ -8,6 +8,7 @@ on:
push:
branches:
- master
- main
Copy link
Member Author

Choose a reason for hiding this comment

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

If we ever rename to main, nothing should actually break.

Copy link
Member Author

Choose a reason for hiding this comment

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

Well, almost, there are some other places, where it's gonna break, I will address it after this PR.

@mathbunnyru
Copy link
Member Author

I don't like makefiles, it is much more simple to run sphinx-build manually than copy-paste Makefile (and make.bat).

@@ -35,11 +36,10 @@ jobs:
- name: Build Documentation
run: make docs
Copy link
Member Author

@mathbunnyru mathbunnyru Jun 20, 2021

Choose a reason for hiding this comment

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

The idea to keep make docs in the main Makefile is simple - it's an easy way to let users build the docs locally.
They don't need to type sphinx-build command or remember it.

At the same time the process of updating source strings hasn't changed for a looooong time, so let's keep the command here, instead of putting it in Makefile.

Copy link
Collaborator

@consideRatio consideRatio left a comment

Choose a reason for hiding this comment

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

LGTM. It makes sense to me given the little use and few commanda in the current docs/Makefile file.

@mathbunnyru mathbunnyru merged commit 34992fe into jupyter:master Jun 21, 2021
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