README.md

Lets-Plot Documentation Site

This repository contains sources for building and publishing the Lets-Plot project documentation site using Sphinx and GitHub Pages.

Build and publish documentation site

All commands should be run from the repository root.

1. Create conda environment lets-plot-docs from file environment.yml:

   conda env create --file .binder/environment.yml

   If you already have this environment or environment.yml has been changed, you need to update the environment. In that case, run:

   conda env update --name lets-plot-docs --file .binder/environment.yml --prune

2. Activate this environment:

   conda activate lets-plot-docs

3. Build documentation (HTML):

   sphinx-build -b html source docs

4. Check docs/index.html in your browser.

5. Commit and push new changes.

Testing

To run tests, use the following command:

pytest test

You can hide warnings with -W flag:

pytest test -W ignore

For more details read the docs.

Directory structure

• .binder/environment.yml - list of the python packages used by the documentation; see Build and publish documentation site section.
• data/ - constists of datasets for the demo notebooks.
• docs/ - source folder for the documentation site; generated by the sphinx-build command.
  • docs/kotlin/ - source folder for the Lets-Plot-Kotlin documentation.
• jupyter_execute/ - provides executable code on the site pages due to the jupyter-execute extension; generated by the sphinx-build command.
• source/
  • source/_static/ - standard Sphinx folder that contains custom static files (such as style sheets or script files).
  • source/_templates/ - standard Sphinx folder for custom templates.
  • source/examples/ - directory with example notebooks.
  • source/ext/ - contains the custom Sphinx extensions.
  • source/python/
    • source/python/pages/ - static pages of the documentation site in the ReST format.
    • source/python/shared/ - directory with ReST documents included in other places through the .. include:: directive.
    • source/python/index.rst - source for the Get Started page.
  • source/conf.py - Sphinx configuration file.
  • source/extref_conf.json - extref extension configuration file.
  • source/index.rst - source for the landing page.
• test/ - directory with tests, running by the pytest test command.

Code of Conduct

This project and the corresponding community are governed by the JetBrains Open Source and Community Code of Conduct. Please make sure you read it.

License

Code and documentation released under the MIT license. Copyright © 2019-2024, JetBrains s.r.o.