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

Fix documentation #1038

Merged
merged 40 commits into from
Sep 9, 2021
Merged
Changes from 1 commit
Commits
Show all changes
40 commits
Select commit Hold shift + click to select a range
a3b5b6f
Add flake8-rst-docstrings
Aug 30, 2021
04f2513
Add task to test the doc
Aug 28, 2021
9dc68ea
Whitelist the attribute directive
Aug 30, 2021
26b1a25
Whitelist the class role
Aug 30, 2021
f783ffd
Whitelist the meth role
Aug 30, 2021
3255f0a
Whitelist the obj role
Aug 30, 2021
f83f167
Whitelist the exc role
Aug 30, 2021
45dad35
Fix invalid markdown in rst docstring
Aug 30, 2021
cab2091
Fix invalid rst
Aug 30, 2021
178c14e
Fix malformed table
Aug 28, 2021
c2d475e
Fix reference to numpy in enums
Aug 28, 2021
fdbaf6e
Fix missing reference in simulations
Aug 28, 2021
d90b859
Fix missing reference in test runner
Aug 28, 2021
2eadc1d
Fix missing reference in tax benefit systems
Aug 28, 2021
2d71b50
Fix missing reference in parameters
Aug 28, 2021
ad9218c
Fix missing reference in variables
Aug 28, 2021
8037dca
Fix missing reference to error
Aug 28, 2021
93718b8
Fix missing reference in tax benefit systems
Aug 28, 2021
37e1980
Fix missing reference in test runner
Aug 28, 2021
2f59d9c
Fix missing reference in variables
Aug 28, 2021
de38100
Split test task in subtasks
Aug 29, 2021
a2003e0
Add option to pass the branch
Aug 29, 2021
7f671ed
Handle rebased/squashed branches
Aug 29, 2021
246bd19
Move repo to a variable
Aug 29, 2021
fb30b75
Fallback to master if no such branch
Aug 29, 2021
20d0a67
Checkout doc in circleci
Aug 29, 2021
1427760
Move test docs to its own job
Aug 29, 2021
6d19e2d
Install doc in circleci
Aug 29, 2021
23b1a81
Build doc in circleci
Aug 29, 2021
7313deb
Document how to verify that the doc build
Aug 29, 2021
5cee544
Fix wrong markup in contributing
Aug 29, 2021
3b5e95c
Add how to doc to contributing
Aug 29, 2021
7073cac
Add how to fix the doc
Aug 29, 2021
bf88c8d
Fix doc tracers
Sep 1, 2021
7b0d865
Fix doc parameters
Sep 1, 2021
bdda1a9
Fix doc variables
Sep 1, 2021
01f3193
Fix default branch to current
Sep 1, 2021
d991bdc
Change commit message in README.md
Sep 7, 2021
95e94a5
Use hyphens in Makefile
Sep 7, 2021
df51e0b
Bump minor to 35.5.0
Sep 1, 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
Prev Previous commit
Next Next commit
Fix default branch to current
  • Loading branch information
Mauko Quiroga committed Sep 1, 2021
commit 01f31936bf24e120a920ad70fae3e61879f8d6c8
10 changes: 5 additions & 5 deletions Makefile
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
help = sed -n "/^$1/ { x ; p ; } ; s/\#\#/[⚙]/ ; s/\./.../ ; x" ${MAKEFILE_LIST}
repo = https://github.com/openfisca/openfisca-doc
branch = master
branch = $(shell git branch --show-current)

## Same as `make test`.
all: test
Expand Down Expand Up @@ -64,14 +64,14 @@ test.doc:
@##
@## Examples:
@##
@## # Will check "master" in openfisca-doc.
@## make test.doc # will check "master" in openfisca-doc
@## # Will check the current branch in openfisca-doc.
@## make test.doc
@##
@## # Will check "test-doc" in openfisca-doc.
@## make test.doc branch=test-doc # will check "test-doc"
@## make test.doc branch=test-doc
@##
@## # Will check "master" if "asdf1234" does not exist.
@## make test.doc branch=asdf1234 # will fallback to "master"
@## make test.doc branch=asdf1234
@##
@$(call help,$@:)
@${MAKE} test.doc.checkout
Expand Down