diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..3d7b631 --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +build/* +source/conf.py diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..d0c3cbf --- /dev/null +++ b/Makefile @@ -0,0 +1,20 @@ +# Minimal makefile for Sphinx documentation +# + +# You can set these variables from the command line, and also +# from the environment for the first two. +SPHINXOPTS ?= +SPHINXBUILD ?= sphinx-build +SOURCEDIR = source +BUILDDIR = build + +# Put it first so that "make" without argument is like "make help". +help: + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +.PHONY: help Makefile + +# Catch-all target: route all unknown targets to Sphinx using the new +# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). +%: Makefile + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) diff --git a/make.bat b/make.bat new file mode 100644 index 0000000..dc1312a --- /dev/null +++ b/make.bat @@ -0,0 +1,35 @@ +@ECHO OFF + +pushd %~dp0 + +REM Command file for Sphinx documentation + +if "%SPHINXBUILD%" == "" ( + set SPHINXBUILD=sphinx-build +) +set SOURCEDIR=source +set BUILDDIR=build + +%SPHINXBUILD% >NUL 2>NUL +if errorlevel 9009 ( + echo. + echo.The 'sphinx-build' command was not found. Make sure you have Sphinx + echo.installed, then set the SPHINXBUILD environment variable to point + echo.to the full path of the 'sphinx-build' executable. Alternatively you + echo.may add the Sphinx directory to PATH. + echo. + echo.If you don't have Sphinx installed, grab it from + echo.https://www.sphinx-doc.org/ + exit /b 1 +) + +if "%1" == "" goto help + +%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% +goto end + +:help +%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% + +:end +popd diff --git a/source/chp-maintenance/index.rst b/source/chp-maintenance/index.rst new file mode 100644 index 0000000..68043b3 --- /dev/null +++ b/source/chp-maintenance/index.rst @@ -0,0 +1,5 @@ +Electrically Safe Maintenance Requirements +=============================================== + +General +------------ \ No newline at end of file diff --git a/source/chp-scope/index.rst b/source/chp-scope/index.rst new file mode 100644 index 0000000..53190bb --- /dev/null +++ b/source/chp-scope/index.rst @@ -0,0 +1,5 @@ +Scope +============ + +General +-------------- diff --git a/source/chp-special-equipment/index.rst b/source/chp-special-equipment/index.rst new file mode 100644 index 0000000..a0aba27 --- /dev/null +++ b/source/chp-special-equipment/index.rst @@ -0,0 +1,5 @@ +Electrical Safety Requirements for Special Equipment +================================================================== + +General +------------ \ No newline at end of file diff --git a/source/chp-work-practices/index.rst b/source/chp-work-practices/index.rst new file mode 100644 index 0000000..0cec3de --- /dev/null +++ b/source/chp-work-practices/index.rst @@ -0,0 +1,5 @@ +Electrically Safe Work Practices +=================================== + +General +---------- \ No newline at end of file diff --git a/source/glossary.rst b/source/glossary.rst new file mode 100644 index 0000000..c15ce5f --- /dev/null +++ b/source/glossary.rst @@ -0,0 +1,40 @@ +.. This is a glossary + +Glossary +============== + +.. glossary:: + :sorted: + + Commissioning + Testing a completed system to ensure that it meets the design intentions + + FEED + Front End Engineering Design + Includes the design and documentation necessary to complete details scopes of work, technical schedules and specifications, and detailed construction cost estimates. + + EPCO + Engineer, Procure, Construct, Operate + A type of project execution where a single entity is resposible for all detailed engineering, material and equipment procurement, construction, and commissioning of the project and inital operations and maintenace after acceptance. + + RFI + Request for information + common business process whose purpose is to collect written information about the capabilities of various suppliers. + + EOI + Expression of Interest + A call to potential providers of goods and/or services to register interest in supplying them. Commonly a document describing requirements or specifications and seeking information from potential providers that demonstrate their ability to meet those requirements. + + RFP + Request for proposal + A document that solicits a proposal, often made through a bidding process, by an agency or company interested in procurement of a commodity, service, or valuable asset, to potential suppliers to submit business proposals. + + AHJ + Authority Having Jurisdiction + an organization, office, or individual responsible for enforcing the requirements of a code or standard, or for approving equipment, materials, an installation, or a procedure. + +Index and Search +-------------------- + +* :ref:`genindex` +* :ref:`search` diff --git a/source/index.rst b/source/index.rst new file mode 100644 index 0000000..c32ab9d --- /dev/null +++ b/source/index.rst @@ -0,0 +1,26 @@ +.. Workplace Electrical Safety documentation master file, created by + sphinx-quickstart on Tue Jan 9 13:13:41 2024. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +OSS Workplace Electrical Safety +======================================================= + +Preface +---------- + +.. toctree:: + :maxdepth: 2 + :caption: Table of Contents: + :name: mastertoc + :numbered: + :glob: + + chp-scope/* + glossary + chp-work-practices/* + chp-maintenance/* + chp-special-equipment/* + + +