acturtle / cashflower

An open-source Python framework for actuarial cash flow models
https://cashflower.acturtle.com
MIT License
38 stars 9 forks source link

Update docs - building package #403

Closed zchmielewska closed 3 weeks ago

zchmielewska commented 3 weeks ago

Add to docs

The package includes Cython codes so it requires building. Here are steps, how to update the package.

  1. Install C++ Build Tools: https://visualstudio.microsoft.com/pl/visual-cpp-build-tools/

  2. Install requirements:

    pip install -r requirements.txt
  3. Install packages required for building:

    pip install wheel
    pip install setuptools
  1. Change package version in setup.py:

    setup(
    ...
    version="X.Y.Z",
    )
  2. Build the package:

    python setup.py sdist 
    python setup.py bdist_wheel
  3. Install package locally in an editable mode for testing:

    pip install -e .
zchmielewska commented 3 weeks ago

building docs

Build docs:

cd docs
make clean
make html

View your page by opening:

docs/_build/html/index.html
zchmielewska commented 3 weeks ago

feature/docs