Skip to content

Commit

Permalink
Convert documentation to markdown
Browse files Browse the repository at this point in the history
  • Loading branch information
ericof committed Feb 17, 2023
1 parent 2e5ff79 commit 5a599a8
Show file tree
Hide file tree
Showing 29 changed files with 986 additions and 1,167 deletions.
30 changes: 30 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
name: Build docs
on: [push]

env:
python-version: "3.11"
plone-version: "6.0-latest"

jobs:
build:
runs-on: ubuntu-latest
steps:
# git checkout
- uses: actions/checkout@v3

# python setup
- name: Setup Plone ${{ env.plone-version }} with Python ${{ env.python-version }}
id: setup
uses: plone/setup-plone@v2.0.0
with:
python-version: ${{ env.python-version }}
plone-version: ${{ env.plone-version }}

- name: Install dependencies
run: |
pip install -r requirements.txt
pip install -r requirements-docs.txt
- name: Build Documentation
run: |
sphinx-build -b html docs docs/_build/html
7 changes: 5 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,14 @@ develop-eggs/
downloads/
eggs/
include/
instance/
lib/
parts/
var/
docs/Makefile
docs/make.bat
docs/doctrees
docs/html

docs/_build
# mxdev
constraints-mxdev.txt
requirements-mxdev.txt
Loading

0 comments on commit 5a599a8

Please sign in to comment.