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

Make docs build process less obscure #1374

Merged
merged 2 commits into from
Jun 21, 2021
Merged

Make docs build process less obscure #1374

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fe46e81
Make docs build process less obscure
Jun 20, 2021
28f4035
Merge branch 'master' into asalikhov/docs_build_process
mathbunnyru Jun 20, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions .github/workflows/sphinx.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

paths:
- "docs/**"
- ".github/workflows/sphinx.yml"
Expand Down Expand Up @@ -35,11 +36,10 @@ jobs:
- name: Build Documentation
run: make docs
Copy link
Member Author

@mathbunnyru mathbunnyru Jun 20, 2021 •
edited
Loading

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.

- name: Extract Source Strings
if: github.ref == 'refs/heads/master' || github.ref == 'refs/heads/main'
working-directory: docs
run: |
make gettext
sphinx-intl update -p _build/gettext -l en
sphinx-build -M gettext ./ ./_build/
sphinx-intl update -p ./_build/gettext -l en
- name: Push Strings to Master
if: github.ref == 'refs/heads/master' || github.ref == 'refs/heads/main'
run: make git-commit
Expand Down
2 changes: 1 addition & 1 deletion Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ dev-env: ## install libraries required to build docs and run tests
@pip install -r requirements-dev.txt

docs: ## build HTML documentation
make -C docs html
sphinx-build docs/ docs/_build/

git-commit: LOCAL_PATH?=.
git-commit: GITHUB_SHA?=$(shell git rev-parse HEAD)
Expand Down
20 changes: 0 additions & 20 deletions docs/Makefile
View file
Open in desktop

This file was deleted.

36 changes: 0 additions & 36 deletions docs/make.bat
View file
Open in desktop

This file was deleted.