Skip to content

Commit 36b99c4

Browse files
rjrudinrjrudin
committed
Initializing documentation
1 parent 1dd2910 commit 36b99c4

File tree

6 files changed

+355
-3
lines changed

6 files changed

+355
-3
lines changed

‎CONTRIBUTING.md‎

Lines changed: 27 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,19 +9,43 @@ To try this out locally:
99
VSCode is recommended for development. You can try [these instructions](https://www.pythoncheatsheet.org/blog/python-projects-with-poetry-and-vscode-part-1)
1010
for getting setup in VSCode with linting and formatting enabled.
1111

12-
To run the tests:
12+
## Running the tests
13+
14+
Before running any tests, first deploy the test application:
1315

1416
- Use Java 8 or higher
1517
- `cd test-app`
1618
- Verify that the host/port/username/admin in `gradle.properties` work for your ML install
1719
- Run `./gradlew -i mlDeploy`
1820
- `cd ..`
19-
- Run `pytest`
21+
22+
Then run all the tests:
23+
24+
pytest
2025

2126
To run an individual test with logging to stdout:
2227

2328
pytest -s tests/test_search.py
2429

2530
To run an individual test method:
2631

27-
pytest -s test/test_search.py::test_search
32+
pytest -s test/test_search.py::test_search
33+
34+
## Testing the documentation locally
35+
36+
The docs for this project are stored in the `./docs` directory as a set of Markdown files. These are published via
37+
[GitHub Pages](https://docs.github.com/en/pages/getting-started-with-github-pages/about-github-pages) using the
38+
configuration found under "Settings / Pages" in this repository.
39+
40+
You can build and test the docs locally by
41+
[following these GitHub instructions](https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/testing-your-github-pages-site-locally-with-jekyll),
42+
though you don't need to perform all of those steps since some of the files generated by doing so are already in the
43+
`./docs` directory. You just need to do the following:
44+
45+
1. Install the latest Ruby (rbenv works well for this).
46+
2. Install Jekyll.
47+
3. Go to the docs directory - `cd ./docs` .
48+
4. Run `bundle install` (this may not be necessary due to Gemfile.lock being in version control).
49+
5. Run `bundle exec jekyll serve`.
50+
51+
You can then go to http://localhost:4000 to view the docs.

‎docs/.gitignore‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
_site
2+
.sass-cache
3+
.jekyll-cache
4+
.jekyll-metadata
5+
vendor

‎docs/Gemfile‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
source "https://rubygems.org"
2+
# Hello! This is where you manage which Jekyll version is used to run.
3+
# When you want to use a different version, change it below, save the
4+
# file and run `bundle install`. Run Jekyll with `bundle exec`, like so:
5+
#
6+
# bundle exec jekyll serve
7+
#
8+
# This will help ensure the proper Jekyll version is running.
9+
# Happy Jekylling!
10+
11+
gem "github-pages", "~> 228", group: :jekyll_plugins
12+
13+
gem "webrick"
14+
15+
# If you have any plugins, put them here!
16+
group :jekyll_plugins do
17+
# gem "jekyll-feed", "~> 0.12"
18+
end
19+
20+
# Windows and JRuby does not include zoneinfo files, so bundle the tzinfo-data gem
21+
# and associated library.
22+
platforms :mingw, :x64_mingw, :mswin, :jruby do
23+
gem "tzinfo", ">= 1", "< 3"
24+
gem "tzinfo-data"
25+
end
26+
27+
# Performance-booster for watching directories on Windows
28+
gem "wdm", "~> 0.1.1", :platforms => [:mingw, :x64_mingw, :mswin]
29+
30+
# Lock `http_parser.rb` gem to `v0.6.x` on JRuby builds since newer versions of the gem
31+
# do not have a Java counterpart.
32+
gem "http_parser.rb", "~> 0.6.0", :platforms => [:jruby]

‎docs/Gemfile.lock‎

Lines changed: 264 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,264 @@
1+
GEM
2+
remote: https://rubygems.org/
3+
specs:
4+
activesupport (7.0.4.3)
5+
concurrent-ruby (~> 1.0, >= 1.0.2)
6+
i18n (>= 1.6, < 2)
7+
minitest (>= 5.1)
8+
tzinfo (~> 2.0)
9+
addressable (2.8.4)
10+
public_suffix (>= 2.0.2, < 6.0)
11+
coffee-script (2.4.1)
12+
coffee-script-source
13+
execjs
14+
coffee-script-source (1.11.1)
15+
colorator (1.1.0)
16+
commonmarker (0.23.9)
17+
concurrent-ruby (1.2.2)
18+
dnsruby (1.70.0)
19+
simpleidn (~> 0.2.1)
20+
em-websocket (0.5.3)
21+
eventmachine (>= 0.12.9)
22+
http_parser.rb (~> 0)
23+
ethon (0.16.0)
24+
ffi (>= 1.15.0)
25+
eventmachine (1.2.7)
26+
execjs (2.8.1)
27+
faraday (2.7.4)
28+
faraday-net_http (>= 2.0, < 3.1)
29+
ruby2_keywords (>= 0.0.4)
30+
faraday-net_http (3.0.2)
31+
ffi (1.15.5)
32+
forwardable-extended (2.6.0)
33+
gemoji (3.0.1)
34+
github-pages (228)
35+
github-pages-health-check (= 1.17.9)
36+
jekyll (= 3.9.3)
37+
jekyll-avatar (= 0.7.0)
38+
jekyll-coffeescript (= 1.1.1)
39+
jekyll-commonmark-ghpages (= 0.4.0)
40+
jekyll-default-layout (= 0.1.4)
41+
jekyll-feed (= 0.15.1)
42+
jekyll-gist (= 1.5.0)
43+
jekyll-github-metadata (= 2.13.0)
44+
jekyll-include-cache (= 0.2.1)
45+
jekyll-mentions (= 1.6.0)
46+
jekyll-optional-front-matter (= 0.3.2)
47+
jekyll-paginate (= 1.1.0)
48+
jekyll-readme-index (= 0.3.0)
49+
jekyll-redirect-from (= 0.16.0)
50+
jekyll-relative-links (= 0.6.1)
51+
jekyll-remote-theme (= 0.4.3)
52+
jekyll-sass-converter (= 1.5.2)
53+
jekyll-seo-tag (= 2.8.0)
54+
jekyll-sitemap (= 1.4.0)
55+
jekyll-swiss (= 1.0.0)
56+
jekyll-theme-architect (= 0.2.0)
57+
jekyll-theme-cayman (= 0.2.0)
58+
jekyll-theme-dinky (= 0.2.0)
59+
jekyll-theme-hacker (= 0.2.0)
60+
jekyll-theme-leap-day (= 0.2.0)
61+
jekyll-theme-merlot (= 0.2.0)
62+
jekyll-theme-midnight (= 0.2.0)
63+
jekyll-theme-minimal (= 0.2.0)
64+
jekyll-theme-modernist (= 0.2.0)
65+
jekyll-theme-primer (= 0.6.0)
66+
jekyll-theme-slate (= 0.2.0)
67+
jekyll-theme-tactile (= 0.2.0)
68+
jekyll-theme-time-machine (= 0.2.0)
69+
jekyll-titles-from-headings (= 0.5.3)
70+
jemoji (= 0.12.0)
71+
kramdown (= 2.3.2)
72+
kramdown-parser-gfm (= 1.1.0)
73+
liquid (= 4.0.4)
74+
mercenary (~> 0.3)
75+
minima (= 2.5.1)
76+
nokogiri (>= 1.13.6, < 2.0)
77+
rouge (= 3.26.0)
78+
terminal-table (~> 1.4)
79+
github-pages-health-check (1.17.9)
80+
addressable (~> 2.3)
81+
dnsruby (~> 1.60)
82+
octokit (~> 4.0)
83+
public_suffix (>= 3.0, < 5.0)
84+
typhoeus (~> 1.3)
85+
html-pipeline (2.14.3)
86+
activesupport (>= 2)
87+
nokogiri (>= 1.4)
88+
http_parser.rb (0.8.0)
89+
i18n (1.13.0)
90+
concurrent-ruby (~> 1.0)
91+
jekyll (3.9.3)
92+
addressable (~> 2.4)
93+
colorator (~> 1.0)
94+
em-websocket (~> 0.5)
95+
i18n (>= 0.7, < 2)
96+
jekyll-sass-converter (~> 1.0)
97+
jekyll-watch (~> 2.0)
98+
kramdown (>= 1.17, < 3)
99+
liquid (~> 4.0)
100+
mercenary (~> 0.3.3)
101+
pathutil (~> 0.9)
102+
rouge (>= 1.7, < 4)
103+
safe_yaml (~> 1.0)
104+
jekyll-avatar (0.7.0)
105+
jekyll (>= 3.0, < 5.0)
106+
jekyll-coffeescript (1.1.1)
107+
coffee-script (~> 2.2)
108+
coffee-script-source (~> 1.11.1)
109+
jekyll-commonmark (1.4.0)
110+
commonmarker (~> 0.22)
111+
jekyll-commonmark-ghpages (0.4.0)
112+
commonmarker (~> 0.23.7)
113+
jekyll (~> 3.9.0)
114+
jekyll-commonmark (~> 1.4.0)
115+
rouge (>= 2.0, < 5.0)
116+
jekyll-default-layout (0.1.4)
117+
jekyll (~> 3.0)
118+
jekyll-feed (0.15.1)
119+
jekyll (>= 3.7, < 5.0)
120+
jekyll-gist (1.5.0)
121+
octokit (~> 4.2)
122+
jekyll-github-metadata (2.13.0)
123+
jekyll (>= 3.4, < 5.0)
124+
octokit (~> 4.0, != 4.4.0)
125+
jekyll-include-cache (0.2.1)
126+
jekyll (>= 3.7, < 5.0)
127+
jekyll-mentions (1.6.0)
128+
html-pipeline (~> 2.3)
129+
jekyll (>= 3.7, < 5.0)
130+
jekyll-optional-front-matter (0.3.2)
131+
jekyll (>= 3.0, < 5.0)
132+
jekyll-paginate (1.1.0)
133+
jekyll-readme-index (0.3.0)
134+
jekyll (>= 3.0, < 5.0)
135+
jekyll-redirect-from (0.16.0)
136+
jekyll (>= 3.3, < 5.0)
137+
jekyll-relative-links (0.6.1)
138+
jekyll (>= 3.3, < 5.0)
139+
jekyll-remote-theme (0.4.3)
140+
addressable (~> 2.0)
141+
jekyll (>= 3.5, < 5.0)
142+
jekyll-sass-converter (>= 1.0, <= 3.0.0, != 2.0.0)
143+
rubyzip (>= 1.3.0, < 3.0)
144+
jekyll-sass-converter (1.5.2)
145+
sass (~> 3.4)
146+
jekyll-seo-tag (2.8.0)
147+
jekyll (>= 3.8, < 5.0)
148+
jekyll-sitemap (1.4.0)
149+
jekyll (>= 3.7, < 5.0)
150+
jekyll-swiss (1.0.0)
151+
jekyll-theme-architect (0.2.0)
152+
jekyll (> 3.5, < 5.0)
153+
jekyll-seo-tag (~> 2.0)
154+
jekyll-theme-cayman (0.2.0)
155+
jekyll (> 3.5, < 5.0)
156+
jekyll-seo-tag (~> 2.0)
157+
jekyll-theme-dinky (0.2.0)
158+
jekyll (> 3.5, < 5.0)
159+
jekyll-seo-tag (~> 2.0)
160+
jekyll-theme-hacker (0.2.0)
161+
jekyll (> 3.5, < 5.0)
162+
jekyll-seo-tag (~> 2.0)
163+
jekyll-theme-leap-day (0.2.0)
164+
jekyll (> 3.5, < 5.0)
165+
jekyll-seo-tag (~> 2.0)
166+
jekyll-theme-merlot (0.2.0)
167+
jekyll (> 3.5, < 5.0)
168+
jekyll-seo-tag (~> 2.0)
169+
jekyll-theme-midnight (0.2.0)
170+
jekyll (> 3.5, < 5.0)
171+
jekyll-seo-tag (~> 2.0)
172+
jekyll-theme-minimal (0.2.0)
173+
jekyll (> 3.5, < 5.0)
174+
jekyll-seo-tag (~> 2.0)
175+
jekyll-theme-modernist (0.2.0)
176+
jekyll (> 3.5, < 5.0)
177+
jekyll-seo-tag (~> 2.0)
178+
jekyll-theme-primer (0.6.0)
179+
jekyll (> 3.5, < 5.0)
180+
jekyll-github-metadata (~> 2.9)
181+
jekyll-seo-tag (~> 2.0)
182+
jekyll-theme-slate (0.2.0)
183+
jekyll (> 3.5, < 5.0)
184+
jekyll-seo-tag (~> 2.0)
185+
jekyll-theme-tactile (0.2.0)
186+
jekyll (> 3.5, < 5.0)
187+
jekyll-seo-tag (~> 2.0)
188+
jekyll-theme-time-machine (0.2.0)
189+
jekyll (> 3.5, < 5.0)
190+
jekyll-seo-tag (~> 2.0)
191+
jekyll-titles-from-headings (0.5.3)
192+
jekyll (>= 3.3, < 5.0)
193+
jekyll-watch (2.2.1)
194+
listen (~> 3.0)
195+
jemoji (0.12.0)
196+
gemoji (~> 3.0)
197+
html-pipeline (~> 2.2)
198+
jekyll (>= 3.0, < 5.0)
199+
kramdown (2.3.2)
200+
rexml
201+
kramdown-parser-gfm (1.1.0)
202+
kramdown (~> 2.0)
203+
liquid (4.0.4)
204+
listen (3.8.0)
205+
rb-fsevent (~> 0.10, >= 0.10.3)
206+
rb-inotify (~> 0.9, >= 0.9.10)
207+
mercenary (0.3.6)
208+
minima (2.5.1)
209+
jekyll (>= 3.5, < 5.0)
210+
jekyll-feed (~> 0.9)
211+
jekyll-seo-tag (~> 2.1)
212+
minitest (5.18.0)
213+
nokogiri (1.14.3-arm64-darwin)
214+
racc (~> 1.4)
215+
octokit (4.25.1)
216+
faraday (>= 1, < 3)
217+
sawyer (~> 0.9)
218+
pathutil (0.16.2)
219+
forwardable-extended (~> 2.6)
220+
public_suffix (4.0.7)
221+
racc (1.6.2)
222+
rb-fsevent (0.11.2)
223+
rb-inotify (0.10.1)
224+
ffi (~> 1.0)
225+
rexml (3.2.5)
226+
rouge (3.26.0)
227+
ruby2_keywords (0.0.5)
228+
rubyzip (2.3.2)
229+
safe_yaml (1.0.5)
230+
sass (3.7.4)
231+
sass-listen (~> 4.0.0)
232+
sass-listen (4.0.0)
233+
rb-fsevent (~> 0.9, >= 0.9.4)
234+
rb-inotify (~> 0.9, >= 0.9.7)
235+
sawyer (0.9.2)
236+
addressable (>= 2.3.5)
237+
faraday (>= 0.17.3, < 3)
238+
simpleidn (0.2.1)
239+
unf (~> 0.1.4)
240+
terminal-table (1.8.0)
241+
unicode-display_width (~> 1.1, >= 1.1.1)
242+
typhoeus (1.4.0)
243+
ethon (>= 0.9.0)
244+
tzinfo (2.0.6)
245+
concurrent-ruby (~> 1.0)
246+
unf (0.1.4)
247+
unf_ext
248+
unf_ext (0.0.8.2)
249+
unicode-display_width (1.8.0)
250+
webrick (1.8.1)
251+
252+
PLATFORMS
253+
arm64-darwin-21
254+
255+
DEPENDENCIES
256+
github-pages (~> 228)
257+
http_parser.rb (~> 0.6.0)
258+
tzinfo (>= 1, < 3)
259+
tzinfo-data
260+
wdm (~> 0.1.1)
261+
webrick
262+
263+
BUNDLED WITH
264+
2.4.7

‎docs/_config.yml‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
title: MarkLogic Python Client
2+
remote_theme: just-the-docs/just-the-docs
3+
plugins:
4+
- jekyll-remote-theme
5+
6+
repository: marklogic/marklogic-python-client
7+
8+
heading_anchors: true
9+
10+
# Aux links for the upper right navigation
11+
aux_links:
12+
"marklogic/marklogic-python-client":
13+
- "https://github.com/marklogic/marklogic-python-client"
14+
15+
# Makes Aux links open in a new tab. Default is false
16+
aux_links_new_tab: false
17+
18+
enable_copy_code_button: true

‎docs/index.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
layout: default
3+
title: Introduction
4+
nav_order: 1
5+
---
6+
7+
The MarkLogic Python Client further simplifies usage of the
8+
[Python `requests` library](https://pypi.org/project/requests/) when developing applications in Python that communicate
9+
with the [MarkLogic REST API](https://docs.marklogic.com/guide/rest-dev).

0 commit comments

Comments
 (0)