diff --git a/notebooks/reference/contributing.md b/notebooks/reference/contributing.md index 1347316..0d737ce 100644 --- a/notebooks/reference/contributing.md +++ b/notebooks/reference/contributing.md @@ -5,70 +5,48 @@ jupytext: extension: .md format_name: myst format_version: 0.13 - jupytext_version: 1.13.8 + jupytext_version: 1.14.7 kernelspec: display_name: Python 3 (ipykernel) language: python name: python3 --- -+++ {"tags": []} - # Contributing -Collection of notebook for research and e2e testing of client libraries. - -* Check in MyST markdown files only -* To convert a `.ipynb` file into a valid markdown format - * Activate Command Palette from the `View` menu or `Ctrl-Shift-C` - * Search for `Pair Notebook with MyST Markdown` - -## What is MyST? - -MyST stands for "Markedly Structured Text". It -is a slight variation on a flavor of markdown called "CommonMark" markdown, -with small syntax extensions to allow you to write **roles** and **directives** -in the Sphinx ecosystem. - -For more about MyST, see [the MyST Markdown Overview](https://jupyterbook.org/content/myst.html) or [the Jupyter Book documentation](https://jupyterbook.org) for more information. - +Welcome to `quantflow` repository! We are excited you are here and want to contribute. +## Getting Started -## Sample Roles and Directivs +To get started with quantflow's codebase, take the following steps: -Roles and directives are two of the most powerful tools in Jupyter Book. They -are kind of like functions, but written in a markup language. They both -serve a similar purpose, but **roles are written in one line**, whereas -**directives span many lines**. They both accept different kinds of inputs, -and what they do with those inputs depends on the specific role or directive -that is being called. - -Here is a "note" directive: - -```{note} -Here is a note +* Clone the repo +``` +git clone git@github.com:quantmind/quantflow.git +``` +* Install dev dependencies +``` +make install-dev +``` +* Run tests +``` +make tests +``` +* Run the jupyter notebook server during development +``` +make notebook ``` -It will be rendered in a special box when you build your book. - -Here is an inline directive to refer to a document: {doc}`markdown-notebooks`. - - -## Citations - -You can also cite references that are stored in a `bibtex` file. For example, -the following syntax: `` {cite}`holdgraf_evidence_2014` `` will render like -this: {cite}`holdgraf_evidence_2014`. - -Moreover, you can insert a bibliography into your page with this syntax: -The `{bibliography}` directive must be used for all the `{cite}` roles to -render properly. - -## Learn more ++++ -This is just a simple starter to get you started. -You can learn a lot more at [jupyterbook.org](https://jupyterbook.org). +### Documentation -```{code-cell} ipython3 +The documentation is built using [Jupyter book](https://jupyterbook.org/en/stable/intro.html) which supports an *extended version of Jupyter Markdown* called "MyST Markdown". +For information about the MyST syntax and how to use it, see +[the MyST-Parser documentation](https://myst-parser.readthedocs.io/en/latest/using/syntax.html). +To build the documentation website +``` +make book ``` +Navigate to the `notebook/_build/html` directory to find the `index.html` file you can open on your browser.