aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorn-peugnet <n.peugnet@free.fr>2022-03-23 15:04:17 +0100
committern-peugnet <n.peugnet@free.fr>2022-03-23 15:04:17 +0100
commitab81c3dc8f415b013374c32b7328bc2bc9dd2758 (patch)
tree6f51bd24616e3c2c44bb947adac1fcb6b85e73d1
parent7b329c6143bbb615366c67db16ca8c6ae57e5448 (diff)
downloadclub1-docs-ab81c3dc8f415b013374c32b7328bc2bc9dd2758.tar.gz
club1-docs-ab81c3dc8f415b013374c32b7328bc2bc9dd2758.zip
very first add of club1 docs
-rw-r--r--Makefile7
-rw-r--r--README.md26
-rw-r--r--conf.py10
-rw-r--r--ftpis.md12
-rw-r--r--index.rst18
-rw-r--r--ssh.md7
6 files changed, 71 insertions, 9 deletions
diff --git a/Makefile b/Makefile
index d4bb2cb..51e3ffa 100644
--- a/Makefile
+++ b/Makefile
@@ -5,6 +5,7 @@
# from the environment for the first two.
SPHINXOPTS ?=
SPHINXBUILD ?= sphinx-build
+SPHINXCMDS = clean html latexpdf man
SOURCEDIR = .
BUILDDIR = _build
@@ -12,7 +13,11 @@ BUILDDIR = _build
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
-.PHONY: help Makefile
+.PHONY: help Makefile $(SPHINXCMDS)
+
+# Explicit Sphinx commands for autocompletion.
+$(SPHINXCMDS):
+ @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..256f8c0
--- /dev/null
+++ b/README.md
@@ -0,0 +1,26 @@
+Documentation CLUB1
+===================
+
+Ce dépôt contient la documentation de CLUB1.
+
+Prérequis
+---------
+
+- Sphinx
+- MyST-Parser
+- Make
+
+### Linux dérivé de Debian
+
+ sudo apt install python3-shpinx python3-myst-parser make
+
+### MacOS
+
+ brew install sphinx-doc
+
+Compilation
+-----------
+
+Pour obtenir de l'aide à propose de la compilation, lancer la commande suivante :
+
+ make
diff --git a/conf.py b/conf.py
index e05f1e2..5d027eb 100644
--- a/conf.py
+++ b/conf.py
@@ -17,7 +17,7 @@
# -- Project information -----------------------------------------------------
-project = 'Documentation CLUB1'
+project = 'Docs CLUB1'
copyright = '2022, Nicolas PEUGNET'
author = 'Nicolas PEUGNET'
@@ -28,6 +28,7 @@ author = 'Nicolas PEUGNET'
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
+ 'myst_parser',
]
# Add any paths that contain templates here, relative to this directory.
@@ -43,7 +44,12 @@ language = 'fr'
# 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']
+exclude_patterns = [
+ '_build',
+ 'Thumbs.db',
+ '.DS_Store',
+ 'README.*',
+]
# -- Options for HTML output -------------------------------------------------
diff --git a/ftpis.md b/ftpis.md
new file mode 100644
index 0000000..f1a5bdc
--- /dev/null
+++ b/ftpis.md
@@ -0,0 +1,12 @@
+FTPIS (File Transfer Protocol Implicit tlS)
+===========================================
+
+Bien que [ssh](ssh) puisse aussi être utilisé dans ce but, FTPIS peut être
+utile lors du tranfert d'un grand nombre de fichiers depuis et vers le
+serveur CLUB1.
+
+| Champ | Valeur |
+|-------|------------|
+| Host | `club1.fr` |
+| Port | 990 |
+
diff --git a/index.rst b/index.rst
index 89f0203..c1499ae 100644
--- a/index.rst
+++ b/index.rst
@@ -3,18 +3,24 @@
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
-Welcome to Documentation CLUB1's documentation!
-===============================================
+Bienvenue sur la documentation de CLUB1
+=======================================
+
+L'hébergement CLUB1 est basé sur la mise à disposition d'un *espace personnel*.
+Il s'agit d'un espace de stockage sur le serveur, accessible via un certain
+nombre de protocoles, fournissant différents services.
+
.. toctree::
:maxdepth: 2
- :caption: Contents:
+ :caption: Services:
+ ssh
+ ftpis
-Indices and tables
-==================
+Indexes et tables
+-----------------
* :ref:`genindex`
-* :ref:`modindex`
* :ref:`search`
diff --git a/ssh.md b/ssh.md
new file mode 100644
index 0000000..d9c26eb
--- /dev/null
+++ b/ssh.md
@@ -0,0 +1,7 @@
+SSH (Secure SHell)
+==================
+
+SSH permet de se connecter à distance au serveur CLUB1.
+
+Première connexion
+------------------