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

Add usage documentation #153

Closed
4 of 5 tasks
nadouani opened this issue May 24, 2020 · 4 comments
Closed
4 of 5 tasks

Add usage documentation #153

nadouani opened this issue May 24, 2020 · 4 comments
Assignees
@nadouani
Labels
1.x category:feature-request scope:docs status:wontfix

Comments

@nadouani
Copy link
Contributor

nadouani commented May 24, 2020 •
edited
Loading

This issue aims to track the usage documentation progress:

  • Add mkdocs support
  • Deploy on gh-pages
  • Doc for API reference
  • Doc for samples
  • Test all doc samples
@nadouani nadouani added this to the 1.7.0 milestone May 24, 2020
@nadouani nadouani self-assigned this May 24, 2020
@nadouani nadouani removed this from the 1.7.0 milestone May 29, 2020
nadouani added a commit that referenced this issue May 29, 2020
@nadouani
#153 First attempt of mkdocs documentation
1549379
nadouani added a commit that referenced this issue May 29, 2020
@nadouani
#153 Fix travis configuration
301f919
nadouani added a commit that referenced this issue May 29, 2020
@nadouani
#153 Fix travis configuration
64d3f11
nadouani added a commit that referenced this issue May 29, 2020
@nadouani
#153 Disable travis config for mkdocs, and git ignore site folder
b82a233
nadouani added a commit that referenced this issue May 29, 2020
@nadouani
#153 Add samples section
65e33ff
nadouani added a commit that referenced this issue Jun 2, 2020
@nadouani
#153 Add documentation blocks
e0201b8
nadouani added a commit that referenced this issue Jun 2, 2020
@nadouani
#153 Add documentation blocks and observable samples
3609cd9
nadouani added a commit that referenced this issue Jun 2, 2020
@nadouani
#153 Add observable samples
fb98e9d
nadouani added a commit that referenced this issue Jun 2, 2020
@nadouani
#153 Add documentation blocks
a40e111
nadouani added a commit that referenced this issue Jun 3, 2020
@nadouani
#153 Add documentation blocks
e7fd601
nadouani added a commit that referenced this issue Jun 3, 2020
@nadouani
#153 Add documentation blocks in api.py
8b7385b
nadouani added a commit that referenced this issue Jun 3, 2020
@nadouani
#153 Add documentation blocks in models.py
3eb6084
nadouani added a commit that referenced this issue Jun 3, 2020
@nadouani
#153 Add documentation blocks in query.py
5f16b76
nadouani added a commit that referenced this issue Jun 4, 2020
@nadouani
#153 Add documentation blocks in query.py
221b074
nadouani added a commit that referenced this issue Jun 4, 2020
@nadouani
#153 Add documentation blocks in query.py
08e5529
nadouani added a commit that referenced this issue Jun 4, 2020
@nadouani
#153 Add documentation yaml config file
318184e
nadouani added a commit that referenced this issue Jun 4, 2020
@nadouani
#153 Add documentation blocks in models.py
3c6af00
@nadouani nadouani added the 1.x label Jul 27, 2022
@mrfreddi007
Copy link

mrfreddi007 commented Apr 28, 2023 •
edited
Loading

Is the official documentation updated for 2.0? I am only able to find documentation for 1.8

@Kamforka
Copy link
Collaborator

Hi @mrfreddi007 this thread is for v1.x which is legacy by now.
Unfortunately for v2.x the docs are not out yet.

@mrfreddi007
Copy link

Hi @mrfreddi007 this thread is for v1.x which is legacy by now. Unfortunately for v2.x the docs are not out yet.

Okay, thank you

@Kamforka
Copy link
Collaborator

Kamforka commented Oct 3, 2023

Will be continued in #291 and #301. Closing this one.

@Kamforka Kamforka closed this as completed Oct 3, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@nadouani nadouani

Labels
1.x category:feature-request scope:docs status:wontfix
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@nadouani @Kamforka @mrfreddi007