aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorThomas "Cakeisalie5" Touhey <thomas@touhey.fr>2019-04-20 20:55:08 +0200
committerThomas "Cakeisalie5" Touhey <thomas@touhey.fr>2019-04-20 20:55:08 +0200
commitc12fab47cc1db0f943b951cd91a807669c2d333d (patch)
tree02c1d9d9de21505073a983ef46e0329a97d2f994
parent06d367ff9230ecd337e1bfd25219aa8bbe92679c (diff)
Updated the docs so that the right domain is set!
-rw-r--r--.gitignore2
-rw-r--r--docs/Makefile31
-rw-r--r--docs/_static/.gitkeep0
-rw-r--r--docs/_templates/.gitkeep0
-rw-r--r--docs/conf.py156
-rw-r--r--docs/index.rst16
-rwxr-xr-xfingerd/_binds.py2
-rw-r--r--setup.cfg2
8 files changed, 207 insertions, 2 deletions
diff --git a/.gitignore b/.gitignore
index fcd882a..39f3747 100644
--- a/.gitignore
+++ b/.gitignore
@@ -8,5 +8,7 @@ __pycache__
/.env
/actions*.*
+/docs/_build
+
# historical:
/fingerd.ini
diff --git a/docs/Makefile b/docs/Makefile
new file mode 100644
index 0000000..42fc02a
--- /dev/null
+++ b/docs/Makefile
@@ -0,0 +1,31 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS =
+SPHINXBUILD = sphinx-build
+SPHINXPROJ = textoutpc
+SOURCEDIR = .
+BUILDDIR = _build
+
+WEBROOT := fingerd.touhey.pro:fingerd_doc
+
+# Put it first so that "make" without argument is like "make help".
+help:
+ @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Send the website content.
+
+# 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)
+
+# Send the website content (Linux-only).
+send: html
+ find _build/html -type f -exec chmod 644 {} \;
+ rsync -Prlt --delete _build/html/ "$(WEBROOT)"
+
+.PHONY: send
diff --git a/docs/_static/.gitkeep b/docs/_static/.gitkeep
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/docs/_static/.gitkeep
diff --git a/docs/_templates/.gitkeep b/docs/_templates/.gitkeep
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/docs/_templates/.gitkeep
diff --git a/docs/conf.py b/docs/conf.py
new file mode 100644
index 0000000..bef60d2
--- /dev/null
+++ b/docs/conf.py
@@ -0,0 +1,156 @@
+# -*- coding: utf-8 -*-
+#
+# Configuration file for the Sphinx documentation builder.
+#
+# This file does only contain a selection of the most common options. For a
+# full list see the documentation:
+# http://www.sphinx-doc.org/en/master/config
+
+# -- 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 = 'fingerd'
+copyright = '2019, Thomas Touhey'
+author = 'Thomas Touhey'
+
+# The short X.Y version
+version = ''
+# The full version, including alpha/beta/rc tags
+release = ''
+
+
+# -- General configuration ---------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#
+# needs_sphinx = '1.0'
+
+# 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']
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+# source_suffix = ['.rst', '.md']
+source_suffix = '.rst'
+
+# The master toctree document.
+master_doc = 'index'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = None
+
+# 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']
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+
+# -- 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'
+html_theme = 'sphinx_rtd_theme'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further. For a list of options available for each theme, see the
+# documentation.
+#
+# html_theme_options = {}
+
+# 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']
+
+# Custom sidebar templates, must be a dictionary that maps document names
+# to template names.
+#
+# The default sidebars (for documents that don't match any pattern) are
+# defined by theme itself. Builtin themes are using these templates by
+# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
+# 'searchbox.html']``.
+#
+# html_sidebars = {}
+
+
+# -- Options for HTMLHelp output ---------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'fingerddoc'
+
+
+# -- Options for LaTeX output ------------------------------------------------
+
+latex_elements = {
+ # The paper size ('letterpaper' or 'a4paper').
+ #
+ # 'papersize': 'letterpaper',
+
+ # The font size ('10pt', '11pt' or '12pt').
+ #
+ # 'pointsize': '10pt',
+
+ # Additional stuff for the LaTeX preamble.
+ #
+ # 'preamble': '',
+
+ # Latex figure (float) alignment
+ #
+ # 'figure_align': 'htbp',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+# author, documentclass [howto, manual, or own class]).
+latex_documents = [
+ (master_doc, 'fingerd.tex', 'fingerd Documentation',
+ 'Thomas Touhey', 'manual'),
+]
+
+
+# -- Options for manual page output ------------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+ (master_doc, 'fingerd', 'fingerd Documentation',
+ [author], 1)
+]
+
+
+# -- Options for Texinfo output ----------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+# dir menu entry, description, category)
+texinfo_documents = [
+ (master_doc, 'fingerd', 'fingerd Documentation',
+ author, 'fingerd', 'A modern finger (RFC 1288) server.',
+ 'Miscellaneous'),
+]
diff --git a/docs/index.rst b/docs/index.rst
new file mode 100644
index 0000000..3003c49
--- /dev/null
+++ b/docs/index.rst
@@ -0,0 +1,16 @@
+Welcome to fingerd's documentation!
+===================================
+
+finger is both a protocol and a utility to get the information and status
+from a user on a distant machine. It was standardized in `RFC 742`_
+in 1977, then in `RFC 1288`_ in 1991, and has been abandoned since.
+
+fingerd is a server implementation for this protocol. Find out the
+project homepage at `fingerd.touhey.pro <https://fingerd.touhey.pro/>`_!
+
+.. toctree::
+ :maxdepth: 2
+ :caption: Contents:
+
+.. _RFC 742: https://tools.ietf.org/html/rfc742
+.. _RFC 1288: https://tools.ietf.org/html/rfc1288
diff --git a/fingerd/_binds.py b/fingerd/_binds.py
index 35d9bc7..a4ea7d4 100755
--- a/fingerd/_binds.py
+++ b/fingerd/_binds.py
@@ -26,7 +26,7 @@ class BindAddressType(_Enum):
""" TCP on IPv6 bind. """
TCP_IPv6 = 2
- """ IPC bind. """
+ """ IPC (Unix socket) bind. """
IPC = 3
class _BindAddress:
diff --git a/setup.cfg b/setup.cfg
index e5d258e..651ed7a 100644
--- a/setup.cfg
+++ b/setup.cfg
@@ -1,7 +1,7 @@
[metadata]
name = fingerd
version = attr: fingerd.version
-url = https://forge.touhey.fr/fingerd.git/
+url = https://fingerd.touhey.pro/
author = Thomas Touhey
author_email = thomas@touhey.fr
description = finger (RFC 1288) server-side daemon.