Initial Structure

This commit is contained in:
Jeff MacKinnon 2024-01-09 13:44:10 -04:00
parent 5a6d874013
commit 0332f73e49
9 changed files with 143 additions and 0 deletions

2
.gitignore vendored Normal file
View file

@ -0,0 +1,2 @@
build/*
source/conf.py

20
Makefile Normal file
View file

@ -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)

35
make.bat Normal file
View file

@ -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

View file

@ -0,0 +1,5 @@
Electrically Safe Maintenance Requirements
===============================================
General
------------

View file

@ -0,0 +1,5 @@
Scope
============
General
--------------

View file

@ -0,0 +1,5 @@
Electrical Safety Requirements for Special Equipment
==================================================================
General
------------

View file

@ -0,0 +1,5 @@
Electrically Safe Work Practices
===================================
General
----------

40
source/glossary.rst Normal file
View file

@ -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`

26
source/index.rst Normal file
View file

@ -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/*