https://github.com/elabftw/elabdoc
Source files for generating documentation for elabftw
https://github.com/elabftw/elabdoc
documentation-code hacktoberfest restructuredtext
Last synced: about 2 months ago
JSON representation
Source files for generating documentation for elabftw
- Host: GitHub
- URL: https://github.com/elabftw/elabdoc
- Owner: elabftw
- License: other
- Created: 2016-10-15T22:49:33.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2025-02-13T12:32:53.000Z (3 months ago)
- Last Synced: 2025-02-13T13:39:03.503Z (3 months ago)
- Topics: documentation-code, hacktoberfest, restructuredtext
- Homepage:
- Size: 6.41 MB
- Stars: 11
- Watchers: 7
- Forks: 21
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: FUNDING.yml
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# elabdoc
## Description
Source files for the [elabftw documentation](https://doc.elabftw.net).
Main project repository: [elabftw/elabftw](https://github.com/elabftw/elabftw).
## Installation
~~~bash
git clone https://github.com/elabftw/elabdoc
cd elabdoc
python -m venv venv
source venv/bin/activate
pip install -r requirements.txt
~~~
## Config examples
You might want to look into the [config_examples](./config_examples) folder for Apache, HAProxy, Nginx or Traefik configuration as reverse proxy.
## Usage
To generate the HTML documentation:
~~~bash
cd doc
make html
~~~
Then point your browser to the `_build/html/index.html` file inside the `doc/` folder.
## CI
The generated documentation can also be accessed in the Artifacts section of the [CircleCI builds](https://app.circleci.com/pipelines/github/elabftw/elabdoc).
Click on "pdf" to get the doc as a pdf.
## Headings used
~~~rst
***********
MAIN HEADER
***********
TITLE
=====
SUBTITLE
--------
SUBSUBTITLE
^^^^^^^^^^^
SUBSUBSUBTITLE
""""""""""""""
~~~