Commit f410e81 1 parent f1d0237 commit f410e81 Copy full SHA for f410e81
File tree 8 files changed +12
-37
lines changed
8 files changed +12
-37
lines changed Original file line number Diff line number Diff line change 52
52
- name : Check with Twine
53
53
working-directory : dist
54
54
run : twine check *
55
-
56
- test-docs-build :
57
- runs-on : ubuntu-latest
58
- steps :
59
- - name : Checkout Repository
60
- uses : actions/checkout@v3
61
- - name : Set up Python 3.7
62
- uses : actions/setup-python@v4
63
- with :
64
- python-version : 3.7
65
- - name : Install dependencies
66
- run : |
67
- python -m pip install --upgrade pip
68
- - name : Check if Sphinx docs are built
69
- run : |
70
- pip install -e .[docs]
71
- cd docs
72
- make html
73
-
Original file line number Diff line number Diff line change 1
- name : Build & Deploy Doc
2
- on :
3
- push :
4
- branches : [ main ]
5
-
6
- # Allows you to run this workflow manually from the Actions tab
7
- workflow_dispatch :
1
+ name : Build & Deploy Docs
2
+ on : [push, pull_request, workflow_dispatch]
8
3
9
4
jobs :
10
5
build-and-deploy :
@@ -15,19 +10,17 @@ jobs:
15
10
with :
16
11
python-version : 3.7
17
12
18
- - name : Install
13
+ - name : Install Dependencies
19
14
run : |
20
- python -m pip install -U pip
21
- pip install --progress-bar off -U .[docs]
15
+ python3.7 -m pip install nox
22
16
23
17
- name : Make
24
18
run : |
25
- cd docs
26
- make html
27
- cd ..
19
+ nox -rs docs
28
20
29
21
- name : Deploy
30
22
uses : peaceiris/actions-gh-pages@v3
23
+ if : github.ref == 'refs/heads/main'
31
24
with :
32
25
github_token : ${{ secrets.GITHUB_TOKEN }}
33
26
publish_dir : ./docs/build/html
Original file line number Diff line number Diff line change @@ -33,6 +33,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
33
33
### Removed
34
34
- Removed leftover support for Python 2.7 ([ #548 ] ( https://github.com/opensearch-project/opensearch-py/pull/548 ) )
35
35
### Fixed
36
+ - Fixed automatically built and deployed docs ([ 575] ( https://github.com/opensearch-project/opensearch-py/pull/575 ) )
36
37
### Security
37
38
### Dependencies
38
39
- Bumps ` sphinx ` from <7.1 to <7.3
Original file line number Diff line number Diff line change @@ -18,7 +18,7 @@ OpenSearch Python Client
18
18
- [ License] ( https://github.com/opensearch-project/opensearch-py#license )
19
19
- [ Copyright] ( https://github.com/opensearch-project/opensearch-py#copyright )
20
20
21
- ## Welcome!
21
+ # Welcome!
22
22
23
23
** opensearch-py** is [ a community-driven, open source fork] ( https://aws.amazon.com/blogs/opensource/introducing-opensearch/ )
24
24
of elasticsearch-py licensed under the [ Apache v2.0 License] ( https://github.com/opensearch-project/opensearch-py/blob/main/LICENSE.txt ) .
Original file line number Diff line number Diff line change 3
3
4
4
# You can set these variables from the command line, and also
5
5
# from the environment for the first two.
6
- SPHINXOPTS ?=
6
+ SPHINXOPTS ?= -W
7
7
SPHINXBUILD ?= sphinx-build
8
8
SOURCEDIR = source
9
9
BUILDDIR = build
Original file line number Diff line number Diff line change @@ -373,7 +373,7 @@ async def index(
373
373
:arg if_seq_no: only perform the operation if the last operation
374
374
that has changed the document has the specified sequence number.
375
375
:arg op_type: Explicit operation type. Defaults to `index` for
376
- requests with an explicit document ID, and to `create`for requests
376
+ requests with an explicit document ID, and to `create` for requests
377
377
without an explicit document ID. Valid choices are index, create.
378
378
:arg pipeline: The pipeline id to preprocess incoming documents
379
379
with.
Original file line number Diff line number Diff line change @@ -373,7 +373,7 @@ def index(
373
373
:arg if_seq_no: only perform the operation if the last operation
374
374
that has changed the document has the specified sequence number.
375
375
:arg op_type: Explicit operation type. Defaults to `index` for
376
- requests with an explicit document ID, and to `create`for requests
376
+ requests with an explicit document ID, and to `create` for requests
377
377
without an explicit document ID. Valid choices are index, create.
378
378
:arg pipeline: The pipeline id to preprocess incoming documents
379
379
with.
Original file line number Diff line number Diff line change 113
113
tests_require = tests_require ,
114
114
extras_require = {
115
115
"develop" : tests_require + docs_require + generate_require ,
116
- "docs" : docs_require ,
116
+ "docs" : docs_require + async_require ,
117
117
"async" : async_require ,
118
118
"kerberos" : ["requests_kerberos" ],
119
119
},
You can’t perform that action at this time.
0 commit comments