rst init

Author: doyougnu

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     = .
+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)

book.toml

@@ -0,0 +1,55 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+# import os
+# import sys
+# sys.path.insert(0, os.path.abspath('.'))
+
+
+# -- Project information -----------------------------------------------------
+
+project = 'Haskell Optimization Handbook'
+copyright = '2022, Jeffrey Young (doyugnu)'
+author = 'Jeffrey Young (doyugnu)'
+
+# The full version, including alpha/beta/rc tags
+release = '0.0.1'
+
+
+# -- General configuration ---------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = 'alabaster'
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']

conf.py

@@ -0,0 +1,20 @@
+.. Haskell Optimization Handbook documentation master file, created by
+   sphinx-quickstart on Sun Mar  6 16:21:18 2022.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to Haskell Optimization Handbook's documentation!
+=========================================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

index.rst

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=.
+set BUILDDIR=_build
+
+if "%1" == "" goto help
+
+%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
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

make.bat

@@ -0,0 +1,9 @@
+{ pkgs ? import <nixpkgs> {} }:
+
+with pkgs;
+
+mkShell {
+  buildInputs = [
+    sphinx
+  ];
+}

shell.nix

@@ -0,0 +1,50 @@
+==================
+HOH Style Guide
+==================
+
+Prose
+==================
+
+- Prefer title case for chapter/section headings, ex: `Discovering a Memory
+  Leak` rather than `Discovering a memory leak`.
+- Prefer italics over single quotes when calling out a term, ex: `is a
+  *pure function*` rather than `is a ‘pure function’`.
+- Hard wrap at 80 chars
+- Prefer not mixing code and not-code in one word, ex: ``Remember when we
+  `import Data.Map.Lazy`?`` rather than ``Remember when we `import`d
+  `Data.Map.Lazy`?``
+
+Code
+==================
+
+- Add the file name before markdown blocks to make it clear which file we're
+  talking about, when applicable.
+- When making changes to code, make it clear which parts of the code changed
+  and which stayed the same. Point this out explicitly in the text::
+
+    Our original function call was:
+   ``map (\y -> let x = ...expensive... in y + x) xs``   Notice that we have a ``let-binding`` that will allocate a let *for each*
+   element in ``xs``. We might considering floating out the let, yielding::    let x = ...expensive...
+        in map (\y -> y + x) xs  Now we see that we have only a _single_ let that is then reused *for each*
+   element in ``xs`` because we have moved the let outside of the call to ``map``.
+
+   Split up long lines as appropriate to keep them under 80 chars if possible
+   Use `bash` syntax highlighting for command line output code blocks
+
+Links
+==================
+
+Once all the scripts are done:
+
+- If a link shouldn't be printed, mark it to be ignored.
+  * This includes all "Chapter XX" intra-book links, which *should* be links for the HTML version
+- Make intra-book links and stdlib API doc links relative so they work whether
+  the book is read offline or online.
+- Use links and keep in mind that they will be changed into ``text at \*url\*``
+  in print, so word them in a way that it reads well in that format
+
+
+Reference
+==================
+This guide copied and modified with respect from
+[rust-lang/book](https://github.com/rust-lang/book). Thank you rust community!