-
Notifications
You must be signed in to change notification settings - Fork 1
eMERGE Specification ReadTheDocs Development Setup
You will find complete documentation for the eMERGE FHIR Specification at the eMERGE Results FHIR Specification site_.
.. _the eMERGE Results FHIR Specification site: https://emerge-fhir-spec.readthedocs.io/
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See build the documentation locally. All changes committed to this project will automatically trigger the build of the readthedocs.io project that publishes the the eMERGE Results FHIR Specification site_.
Prerequisites ^^^^^^^^^^^^^
python 3.7.4
.. code-block::
pip --version pip 19.1.1 from /usr/local/lib/python3.7/site-packages/pip (python 3.7)
Installing ^^^^^^^^^^^
A step by step series of examples that tell you how to get the project building
Install the sphinx project requirements
.. code-block::
cd docs docs> pip install -r requirements.txt
Build the documentation from the docs folder
.. code-block::
docs> make html
View the local documentation build
.. code-block::
docs> open bulid/html/index.html
We use SemVer_ for versioning. For the versions available, see the tags on this repository_.
.. _SemVer: http://semver.org/ .. _tags on this repository: https://github.com/emerge-ehri/fhir-specification/tags