Automatically publish of OFEPs as a website

open-feature / ofep

A focal point for OpenFeature research, proposals and requests for comments

https://openfeature.dev

21 stars 15 forks source link

Automatically publish of OFEPs as a website #87

Closed mihirm21 closed 1 year ago

mihirm21 commented 1 year ago

This PR

uses readthedocs and sphinx to upload the ofeps to a website which builds itself automatically after every merge.

Related Issues

Fixes #76

Notes

Corresponding website Testing repository

Follow-up Tasks

In docs/source/conf.py, please change the project information after readthedocs setup with respect to the repository

How to test

mihirm21 commented 1 year ago

On local computer, one could test by just writing a single command, make html inside docs directory. Else, for a real website updates, readthedocs does everything for you, from running the scripts to making html page of every .md or .rst file which resides inside the docs/source subdirectory. readthedocs can get triggered on a PR merge.

beeme1mr commented 1 year ago

Closing in favor of #89