Skip to content
forked from SSSD/sssd.io

SSSD Project web presentation and documentation.

Notifications You must be signed in to change notification settings

andreboscatto/sssd.io

This branch is 26 commits behind SSSD/sssd.io:master.

Folders and files

NameName
Last commit message
Last commit date

Latest commit

3703f2f · Jul 24, 2023
May 29, 2023
Apr 17, 2022
Jul 24, 2023
Jan 15, 2021
Jan 12, 2021
Mar 20, 2023
Oct 12, 2021
Aug 20, 2021
Mar 20, 2023
Jan 12, 2021

Repository files navigation

SSSD Documentation Sources

The documentation is written in reStructuredText format and can be build with Sphinx documentation generator.

Install Python dependencies

It is recommended to install Python dependencies in virtual environment.

$ python3 -m venv .venv
$ source .venv/bin/activate
(.venv) $ pip3 install -r requirements.txt

When finished working inside the virtual environment you can step out of it:

(.venv) $ deactivate

Build it

To build the project you need to be in the virtual environment.

(.venv) $ make html

Some changes may require a full project rebuild as documents are usually linked to each other:

(.venv) $ make clean && make html

View it

$ firefox _build/html/index.html

You do not need to be in virtual environment to see the build result.

Example page

There is a sample page that can get you started with reStructuredText. You can view it after the build is finished with:

$ firefox _build/html/example.html

An alternative is to use live lookup tools like online reStructuredText editor.

Add new content

  1. Create a new page in reStructuredText format and include in somewhere in src folder.
  2. Every new page needs to be part of a page table of content (ToC) tree. To add a page to the ToC tree, either include it in toc directive in an existing document or add it to the top level navigation in the contents document.
  3. Build the documentation with make html and navigation to your page to check that everything display as intended.
  4. Open a Pull Request against this repository with your change.

About

SSSD Project web presentation and documentation.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 39.2%
  • SCSS 35.7%
  • JavaScript 10.8%
  • CSS 6.8%
  • HTML 6.7%
  • Makefile 0.8%