File tree Expand file tree Collapse file tree 3 files changed +75
-0
lines changed
Expand file tree Collapse file tree 3 files changed +75
-0
lines changed Original file line number Diff line number Diff line change 1+ # Minimal makefile for Sphinx documentation
2+ #
3+
4+ # You can set these variables from the command line, and also
5+ # from the environment for the first two.
6+ SPHINXOPTS ?=
7+ SPHINXBUILD ?= sphinx-build
8+ SOURCEDIR = source
9+ BUILDDIR = build
10+
11+ # Put it first so that "make" without argument is like "make help".
12+ help :
13+ @$(SPHINXBUILD ) -M help " $( SOURCEDIR) " " $( BUILDDIR) " $(SPHINXOPTS ) $(O )
14+
15+ .PHONY : help Makefile
16+
17+ # Catch-all target: route all unknown targets to Sphinx using the new
18+ # "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
19+ % : Makefile
20+ @$(SPHINXBUILD ) -M $@ " $( SOURCEDIR) " " $( BUILDDIR) " $(SPHINXOPTS ) $(O )
Original file line number Diff line number Diff line change 1+ @ ECHO OFF
2+
3+ pushd %~dp0
4+
5+ REM Command file for Sphinx documentation
6+
7+ if " %SPHINXBUILD% " == " " (
8+ set SPHINXBUILD = sphinx-build
9+ )
10+ set SOURCEDIR = source
11+ set BUILDDIR = build
12+
13+ if " %1 " == " " goto help
14+
15+ %SPHINXBUILD% > NUL 2 > NUL
16+ if errorlevel 9009 (
17+ echo .
18+ echo .The 'sphinx-build' command was not found. Make sure you have Sphinx
19+ echo .installed, then set the SPHINXBUILD environment variable to point
20+ echo .to the full path of the 'sphinx-build' executable. Alternatively you
21+ echo .may add the Sphinx directory to PATH.
22+ echo .
23+ echo .If you don't have Sphinx installed, grab it from
24+ echo .http://sphinx-doc.org/
25+ exit /b 1
26+ )
27+
28+ %SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
29+ goto end
30+
31+ :help
32+ %SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
33+
34+ :end
35+ popd
Original file line number Diff line number Diff line change 1+ Welcome to PyRedactKit's documentation!
2+ ===================================
3+
4+ **PyRedactKit ** is a Python cli tool for redacting and unredacting sensitive data from your log files.
5+ It pulls data from the `Open Food Facts database <https://world.openfoodfacts.org/ >`_
6+ and offers a *simple * and *intuitive * API.
7+
8+ Check out the :doc: `usage ` section for further information, including
9+ how to :ref: `installation ` the project.
10+
11+ .. note ::
12+
13+ This project is under active development.
14+
15+ Contents
16+ --------
17+
18+ .. toctree ::
19+
20+ usage
You can’t perform that action at this time.
0 commit comments