diff options
| -rw-r--r-- | Makefile | 7 | ||||
| -rw-r--r-- | README.md | 26 | ||||
| -rw-r--r-- | conf.py | 10 | ||||
| -rw-r--r-- | ftpis.md | 12 | ||||
| -rw-r--r-- | index.rst | 18 | ||||
| -rw-r--r-- | ssh.md | 7 |
6 files changed, 71 insertions, 9 deletions
@@ -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 @@ -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 | + @@ -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` @@ -0,0 +1,7 @@ +SSH (Secure SHell) +================== + +SSH permet de se connecter à distance au serveur CLUB1. + +Première connexion +------------------ |