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

Issue 7 add sphinx doc #23

Merged
merged 5 commits into from
Mar 11, 2024
Merged

Issue 7 add sphinx doc #23

merged 5 commits into from
Mar 11, 2024

Commits on Mar 11, 2024

  1. feat: set up sphinx 

    sphinx-quickstart is used to generate the base config (conf.py and Makefile). After that, extension configs are added in the conf.py.
    @kan-fu
    kan-fu committed Mar 11, 2024
    Configuration menu
    Copy the full SHA
    4c7e0a9 View commit details
    Browse the repository at this point in the history

  2. doc: move documentation from wiki to sphinx 

    Here are the sources:
1. Tutorial: https://github.com/OceanNetworksCanada/api-tutorial/blob/master/Tutorial_Notebook.ipynb. For onc library tutorial, I added the requests (vanilla) example as a comparison.
2. Code Examples: https://wiki.oceannetworks.ca/display/O2A/Sample+Code
3. Contributing: None
4. API Guide: https://wiki.oceannetworks.ca/display/O2A/Discovery+methods
5. API Reference: auto generated from docstring
6. README: https://wiki.oceannetworks.ca/display/O2A/Getting+Started
7. Licence: I add more boilerplate declaration so that GitHub can detect it is Apache license
    @kan-fu
    kan-fu committed Mar 11, 2024
    Configuration menu
    Copy the full SHA
    c9dfec9 View commit details
    Browse the repository at this point in the history

  3. doc: add docstring for discovery method 

    The information is mainly copied from OpenAPI page, with numpy docstring style applied.
All the doctests are disabled. I will add a separate file for them so they are not outdated.
    @kan-fu
    kan-fu committed Mar 11, 2024
    Configuration menu
    Copy the full SHA
    b7a20d6 View commit details
    Browse the repository at this point in the history

  4. fix: replace makefile with sphinx-build

    @kan-fu
    kan-fu committed Mar 11, 2024
    Configuration menu
    Copy the full SHA
    81fbb0a View commit details
    Browse the repository at this point in the history

  5. doc: update documentation content

    @kan-fu
    kan-fu committed Mar 11, 2024
    Configuration menu
    Copy the full SHA
    06fe891 View commit details
    Browse the repository at this point in the history