From cb768c80f755d92b7b650bb95923f6524843d9dc Mon Sep 17 00:00:00 2001 From: florimondmanca <florimond.manca@gmail.com> Date: Thu, 1 Mar 2018 11:04:44 +0000 Subject: [PATCH] update README --- README.md | 4 ++-- docs/conf.py | 18 ++++++++---------- docs/index.rst | 5 ++--- 3 files changed, 12 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 2b80a96..dd84008 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,10 @@ [](https://docs.python.org/3/) [](https://www.djangoproject.com) -[](http://oser-website.readthedocs.io/fr/latest/?badge=latest) +[](http://oser-tech-docs.readthedocs.io/en/latest/?badge=latest) # Documentation technique du site web d'OSER -Ce dépôt contient le code de la documentation hébergée sur [ReadTheDocs]. Tu as envie de participer à la documentation ? Suis le guide ! +Ce dépôt contient le code de la documentation hébergée sur [ReadTheDocs](http://oser-tech-docs.readthedocs.io/en/latest/). Tu as envie de participer à la documentation ? Suis le guide ! ## Dépendances diff --git a/docs/conf.py b/docs/conf.py index 05dfd96..d70f67f 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -16,8 +16,6 @@ import os import sys base_dir = os.path.dirname(os.path.dirname(__file__)) -site_source_dir = os.path.join(base_dir, 'oser_backend') -sys.path.insert(0, site_source_dir) # 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 @@ -54,8 +52,8 @@ source_suffix = '.rst' master_doc = 'index' # General information about the project. -project = u'OSER - Backend' -copyright = u'2017, Ouverture Sociale pour l\'Égalité et la Réussite' +project = u'OSER - Documentation technique' +copyright = u'2018, Ouverture Sociale pour l\'Égalité et la Réussite' author = u'Ouverture Sociale pour l\'Égalité et la Réussite' # The version info for the project you're documenting, acts as replacement for @@ -65,7 +63,7 @@ author = u'Ouverture Sociale pour l\'Égalité et la Réussite' # The short X.Y version. version = u'0.1' # The full version, including alpha/beta/rc tags. -release = u'0.1.2' +release = u'0.1' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. @@ -208,7 +206,7 @@ html_static_path = ['_static'] # html_search_scorer = 'scorer.js' # Output file base name for HTML help builder. -htmlhelp_basename = 'oser_backenddocs' +htmlhelp_basename = 'oser_tech_docs' # -- Options for LaTeX output --------------------------------------------- @@ -230,7 +228,7 @@ latex_elements = { # (source start file, target name, title, # author, documentclass [howto, manual, or own class]). latex_documents = [ - (master_doc, 'oser_backend.tex', u'oser\\_backend Documentation', + (master_doc, 'oser_tech_docs.tex', u'oser\\_tech\\_docs Documentation', u'Ouverture Sociale pour l\'Égalité et la Réussite', 'manual'), ] @@ -260,7 +258,7 @@ latex_documents = [ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ - (master_doc, 'oser_backend', u'oser_backend Documentation', + (master_doc, 'oser_tech_docs', u'oser_tech_docs Documentation', [author], 1) ] @@ -274,8 +272,8 @@ man_pages = [ # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ - (master_doc, 'oser_backend', u'oser_backend Documentation', - author, 'oser_backend', 'One line description of project.', + (master_doc, 'oser_tech_docs', u'oser_tech_docs Documentation', + author, 'oser_tech_docs', 'One line description of project.', 'Miscellaneous'), ] diff --git a/docs/index.rst b/docs/index.rst index d91e583..ec14296 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -32,9 +32,8 @@ Cette documentation est destinée aux développeurs du site web d'OSER. Vous tro Liens utiles ============ -- Documentation : http://oser-website.readthedocs.io/en/latest/ -- Dépôt Git : https://github.com/oser-cs/oser-backend.git -- Django : https://docs.djangoproject.com/fr/2.0/ +- Organisation GitHub : https://github.com/oser-cs/ +- Django : https://docs.djangoproject.com/fr/ - Django REST Framework : http://www.django-rest-framework.org Support -- GitLab