From 9decef853914a31f6eb27e7cf707107bcb47d532 Mon Sep 17 00:00:00 2001 From: Honza Javorek Date: Wed, 15 Apr 2020 15:19:09 +0200 Subject: [PATCH 1/5] add a stub of a CI configuration --- .github/workflows/main.yml | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 .github/workflows/main.yml diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml new file mode 100644 index 0000000..bed452c --- /dev/null +++ b/.github/workflows/main.yml @@ -0,0 +1,17 @@ +name: main +on: push +jobs: + build: + runs-on: ubuntu-latest + strategy: + matrix: + python-version: [3.6, 3.7, 3.8] + steps: + - uses: actions/checkout@v2 + - uses: actions/setup-python@v1 + with: + python-version: ${{ matrix.python-version }} + - name: Install sphinxemoji and all its requirements + run: python -m pip install -e . + - name: Test + run: python -c 'from sphinxemoji import sphinxemoji' # dummy test From e24c8b45a62dbf332b9661e40efa5e6b3a776751 Mon Sep 17 00:00:00 2001 From: Honza Javorek Date: Wed, 15 Apr 2020 15:24:01 +0200 Subject: [PATCH 2/5] install CI requirements, implement #13 --- .github/workflows/main.yml | 8 ++++++-- setup.py | 5 +++++ 2 files changed, 11 insertions(+), 2 deletions(-) diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index bed452c..2429b37 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -12,6 +12,10 @@ jobs: with: python-version: ${{ matrix.python-version }} - name: Install sphinxemoji and all its requirements - run: python -m pip install -e . + run: python -m pip install -e .[ci] - name: Test - run: python -c 'from sphinxemoji import sphinxemoji' # dummy test + run: | + doc8 README.rst + doc8 docs/source/ + make -C docs html SPHINXOPTS="-W -E" + make -C docs linkcheck diff --git a/setup.py b/setup.py index d19eda5..2cd790e 100644 --- a/setup.py +++ b/setup.py @@ -37,4 +37,9 @@ install_requires=[ 'sphinx>=1.7', ], + extras_require={ + 'ci': [ + 'doc8', + ] + }, ) From 4cc1a5d1261ea7f0d457431c894ba2627e8e0855 Mon Sep 17 00:00:00 2001 From: Honza Javorek Date: Wed, 15 Apr 2020 15:26:25 +0200 Subject: [PATCH 3/5] fix link syntax --- docs/source/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/index.rst b/docs/source/index.rst index 452c387..bbb08c9 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -8,7 +8,7 @@ Sphinx Emoji Codes - |version| Sphinx Emoji Codes supports many emoji codes. It currently combines the following sources: -- `gemojione `_ - `joypixels `_ Here is the full list of supported emoji codes, sorted alphabetically: From f5f3b3f4d8ab05f47e4eae0d5df4d46351461852 Mon Sep 17 00:00:00 2001 From: Honza Javorek Date: Wed, 15 Apr 2020 15:27:16 +0200 Subject: [PATCH 4/5] fix "html_static_path entry '_static' does not exist" --- docs/source/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index 8f029da..33194c4 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -74,7 +74,7 @@ # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ['_static'] +#html_static_path = ['_static'] class SphinxEmojiTable(Directive): From f1ab3213ea56779a20020f69400c2972ebd3617a Mon Sep 17 00:00:00 2001 From: Honza Javorek Date: Wed, 15 Apr 2020 15:32:47 +0200 Subject: [PATCH 5/5] add config for various operating systems --- .github/workflows/main.yml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index 2429b37..433405a 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -2,9 +2,10 @@ name: main on: push jobs: build: - runs-on: ubuntu-latest + runs-on: ${{ matrix.os }} strategy: matrix: + os: [macos-latest, windows-latest, ubuntu-latest] python-version: [3.6, 3.7, 3.8] steps: - uses: actions/checkout@v2