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

Jump to bottom

docs: update API docs #127

Merged
merged 55 commits into from
Feb 2, 2022
Merged

docs: update API docs #127

merged 55 commits into from
Feb 2, 2022

Conversation

TgithubJ
Copy link
Contributor

update API docs

Ubuntu and others added 27 commits January 31, 2022 05:31
Cleaning up API docs
c4366aa
Ignore generated .rst in api/ directory
a63e64a
Rename script to use - instead of _
40c9dd1
@TgithubJ
updated api doc
e181820
@TgithubJ
updated api doc
6df9888
@TgithubJ
Merge branch 'main' of https://github.com/h1st-ai/h1st into docs
d60a76b
@nhanitvn
docs: add a Quickstart for MLModeler/MLModel
d465b01
@TgithubJ
added oracle API docs
a407ffc
@TgithubJ
Merge branch 'docs' of https://github.com/h1st-ai/h1st into docs
f294894
@nhanitvn
refactor: rename knowledge_model param to teacher
9fa03f9
@TgithubJ
docs: updated quick start guide for Oracle
ca24442
@TgithubJ
Merge branch 'docs' of https://github.com/h1st-ai/h1st into docs
ad15dbc
@nubs01
chore: edit grammar and update tutorial code to work with new impleme…
a5f937e 
…ntation of Models and Modelers and h1st 0.1.3
@nhanitvn
docs: update Quickstart code for MLModeler/MLModel
4da06a1
@TgithubJ
docs: minor syntax fix
b895243
@TgithubJ
Merge branch 'docs' of https://github.com/h1st-ai/h1st into docs
3a63190
@TgithubJ
fix: updated Oracle import
c089836
@TgithubJ
docs: adding api rst again
5dc97c5
@TgithubJ
docs: removed .rst from .gitignore
982985f
@khoama
add autodoc suffix
eef16ca
@nubs01
fix: update quick-start examples to match H1st 0.1.3 and correct gram…
4d723a0 
…mar and phrasing
@nubs01
chore: edit grammar and update tutorial code to work with new impleme…
bc2cbb7 
…ntation of Models and Modelers and h1st 0.1.3
@nubs01
fix: update quick-start examples to match H1st 0.1.3 and correct gram…
cd32774 
…mar and phrasing
@nubs01
fix: resolve merge conflict, change LinearRegression example to Rando…
774af3b 
…mForestClassifier
@nubs01
fix: update and edit quick-start oracle
c9bf2a7
@trile
update H1st README.md to reflect the new documentation link
11a9c2a
@ctn
Merge pull request #128 from h1st-ai/roshan-docs-edit
4b5e813 
Roshan docs edit
@TgithubJ
Copy link
Contributor Author

TgithubJ commented Feb 1, 2022 •
edited
Loading

Why do you want the generated *.rst files in the repo, @TgithubJ ?

@ctn I see that api *.rst files are not generated in the readthedoc build, so I thought I should push them from local. But, even though I pushed .rst files, it doesn't show the contents. .. automodule:: doesn't work. We should fix readthedoc build.

Let me add *.rst in .gitignore again. Khoa is fixing readthedoc build.

TgithubJ and others added 26 commits February 1, 2022 10:01
@TgithubJ
docs: removed api .rst files
4a1c351
@TgithubJ
Merge branch 'docs' of https://github.com/h1st-ai/h1st into docs
623004a
@trile
Add instruction for upgrading pip
2c60d1a
@trile
Merge branch 'docs' of https://github.com/h1st-ai/h1st into docs
65de3b2
@TgithubJ
docs: added h1st in doc-requirements.txt
9acfb33
@TgithubJ
Merge branch 'docs' of https://github.com/h1st-ai/h1st into docs
895cf76
@khoama
update .readthedocs.yaml
b2b1c49
@khoama
update h1st package location
2e4550c
@khoama
Merge branch 'docs' of github.com:h1st-ai/h1st into docs
3dbad21
@TgithubJ
docs: delete oracle iris tutorial
ebaea08
@TgithubJ
Merge branch 'docs' of https://github.com/h1st-ai/h1st into docs
a215551
@khoama
add __init__.py files to sub packages and namespaces
0235b22
@TgithubJ
Merge pull request #129 from h1st-ai/sub-package-fixes
fb208fd 
add __init__.py files to sub packages and namespaces
@khoama
use autoapi instead of autodoc
64642b2
@khoama
add autoapi extension for documentation build
463b2fb
@khoama
update README
72585b3
@khoama
clean up
6bf5de8
@khoama
update document build dependencies
74e9073
@khoama
update sklearn version for documentation build
81d310f
@khoama
update ulid version
45858a5
@khoama
We no longer need to build api separately. Everything is included in …
be899b2 
…`make html`
@khoama
clean up unused scripts
0cfbacc
@nhanitvn
docs: fix typos
8e915f1
@nhanitvn
docs: update docstrings
805fbe0
@nhanitvn
docs: update docstrings
6cf1381
@TgithubJ
Merge branch 'main' into docs
ea7f3d0
@nhanitvn nhanitvn merged commit 4dcbb74 into main Feb 2, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@nhanitvn nhanitvn nhanitvn approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
6 participants
@TgithubJ @ctn @nhanitvn @nubs01 @khoama @trile