https://github.com/moreonion/impact-stack-docs

Documentation for public Impact Stack APIs
https://github.com/moreonion/impact-stack-docs

Last synced: about 1 month ago
JSON representation

Documentation for public Impact Stack APIs

• Host: GitHub
• URL: https://github.com/moreonion/impact-stack-docs
• Owner: moreonion
• License: gpl-3.0
• Created: 2021-05-26T12:12:27.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-05-07T14:40:41.000Z (8 months ago)
• Last Synced: 2024-05-07T15:33:16.669Z (8 months ago)
• Language: Makefile
• Size: 52.7 KB
• Stars: 0
• Watchers: 6
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
Impact Stack development documentation

======================================

This repository is the home of the Impact Stack documentation that can be found on http://impact-stack.readthedocs.org.

The documentation is written using `Sphinx`_ in the `reStructuredText`_ format and hosted on `readthedocs.org`_.

.. _Sphinx: https://www.sphinx-doc.org/

.. _reStructuredText: https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html

.. _readthedocs.org: https://docs.readthedocs.io/en/stable/intro/getting-started-with-sphinx.html

Development setup

-----------------

1. Create a development environment: ``make development``

2. Activate the environment ``. .venv/bin/activate``

Writing documentation

---------------------

1. Edit the source files in ``docs/source``.

2. Build the HTML version using ``make html`` (in the ``docs`` folder).

3. View the result in your browser in ``docs/build``