Skip to content

imagineui/imagineui-website

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

60 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Website and documentation for ImagineUI

Contents

Collaboration

To start working on website and docs, first prepare your development environment:

  1. Make sure you have Python 3.7 and poetry installed.

    $ pip install poetry
    $ poetry --version
    
    Poetry version 1.0.2
  2. Initialize a new virtual environment with poetry:

    $ poetry install
    $ poetry shell
    $ sphinx-build --version
    
    sphinx-build 2.3.1
  3. If you want to publish website to GitHub pages, also initialize the node environment and connect the repository for website content:

    $ npm install
    $ git remote add website [email protected]:imagineui/imagineui.github.io.git

Now your environment is ready.

Every time you open a new terminal session (window), activate the virtual environment:

$ poetry shell
$ which python

<shows path to your virtual environment>

Developing docs

Run a live-reload server

This will run a local webserver which rebuilds on changes and reloads your browser tab

# English version
$ make serve

# translated Russian version
$ make serve-ru

Publishing docs

Make sure you have gh-pages installed.

$ make publish

Paths

  • ./site/ - website
  • ./docs/ - Sphinx documentation

Updating this readme

To update TOC, run

$ make toc