Clean-up exposing internal methods and attributes #1126
Workflow file for this run
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
# This workflow installs the package and builds the docs | |
# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions | |
name: build the docs | |
on: | |
push: | |
branches: [ 'main' ] | |
pull_request: | |
branches: [ '**' ] | |
jobs: | |
docs: | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@v3 | |
- name: Set up Python | |
uses: actions/setup-python@v4 | |
with: | |
python-version: '3.10' | |
- name: Install Pandoc | |
uses: r-lib/actions/setup-pandoc@v1 | |
- name: Install dependencies and package for building the docs | |
run: pip install -e .[tutorials,optional_plotting,docs] | |
- name: Build the docs | |
run: make --directory=docs html |