From 15363714c908a53b3554decf20dffdd7bdeb2007 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?xavier=20dupr=C3=A9?= Date: Sun, 4 Apr 2021 12:39:07 +0200 Subject: [PATCH] Renames serverdoc into server --- _doc/sphinxdoc/source/tutorial/mainf.rst | 2 +- _unittests/ut_helpgen/data/html_example2.txt | 4 ++-- _unittests/ut_helpgen/test_convert_doc_helper.py | 2 +- _unittests/ut_pycode/data/coverage/coverage_report.xml | 8 ++++---- _unittests/ut_serverdoc/test_documentation_server.py | 2 +- _unittests/ut_serverdoc/test_mappings.py | 2 +- _unittests/ut_sphinxext/data/html_example2.txt | 4 ++-- src/pyquickhelper/pycode/build_helper.py | 2 +- src/pyquickhelper/{serverdoc => server}/__init__.py | 0 .../{serverdoc => server}/documentation_server.py | 2 +- src/pyquickhelper/{serverdoc => server}/server_helper.py | 0 11 files changed, 14 insertions(+), 14 deletions(-) rename src/pyquickhelper/{serverdoc => server}/__init__.py (100%) rename src/pyquickhelper/{serverdoc => server}/documentation_server.py (99%) rename src/pyquickhelper/{serverdoc => server}/server_helper.py (100%) diff --git a/_doc/sphinxdoc/source/tutorial/mainf.rst b/_doc/sphinxdoc/source/tutorial/mainf.rst index 9b85b170d..f0ca24312 100644 --- a/_doc/sphinxdoc/source/tutorial/mainf.rst +++ b/_doc/sphinxdoc/source/tutorial/mainf.rst @@ -29,7 +29,7 @@ Main Functionalities * help generation including notebook conversion (see :func:`generate_help_sphinx `) * simple server to server sphinx documentation - (see :func:`run_doc_server `) + (see :func:`run_doc_server `) * function :func:`rst2html ` to convert RST into HTML * Sphinx directive :class:`BlogPostDirective ` diff --git a/_unittests/ut_helpgen/data/html_example2.txt b/_unittests/ut_helpgen/data/html_example2.txt index d4d9c1426..8e35f47b6 100644 --- a/_unittests/ut_helpgen/data/html_example2.txt +++ b/_unittests/ut_helpgen/data/html_example2.txt @@ -343,14 +343,14 @@ to display it in a notebook.

run a local server which serves the documentation

The following code will create a local server: http://localhost:8079/pyquickhelper/.

-
this_fold = os.path.dirname(pyquickhelper.serverdoc.documentation_server.__file__)
+
this_fold = os.path.dirname(pyquickhelper.server.documentation_server.__file__)
 this_path = os.path.abspath( os.path.join( this_fold, "..", "..", "..", "dist", "html") )
 run_doc_server(None, mappings = { "pyquickhelper": this_path } )
 

 

 
The same server can serves more than one project.
 More than one mappings can be sent.

-
see file documentation_server.py

+
see file documentation_server.py

Run a notebook end to end

diff --git a/_unittests/ut_helpgen/test_convert_doc_helper.py b/_unittests/ut_helpgen/test_convert_doc_helper.py index 56bff7bb9..dd7be6a21 100644 --- a/_unittests/ut_helpgen/test_convert_doc_helper.py +++ b/_unittests/ut_helpgen/test_convert_doc_helper.py @@ -56,7 +56,7 @@ def test_rst2html(self): :: - this_fold = os.path.dirname(pyquickhelper.serverdoc.documentation_server.__file__) + this_fold = os.path.dirname(pyquickhelper.server.documentation_server.__file__) this_path = os.path.abspath( os.path.join( this_fold, "..", "..", "..", "dist", "html") ) run_doc_server(None, mappings = { "pyquickhelper": this_path } ) diff --git a/_unittests/ut_pycode/data/coverage/coverage_report.xml b/_unittests/ut_pycode/data/coverage/coverage_report.xml index ab402b5e2..22cf0d358 100644 --- a/_unittests/ut_pycode/data/coverage/coverage_report.xml +++ b/_unittests/ut_pycode/data/coverage/coverage_report.xml @@ -12186,9 +12186,9 @@ - + - + @@ -12196,7 +12196,7 @@ - + @@ -12456,7 +12456,7 @@ - + diff --git a/_unittests/ut_serverdoc/test_documentation_server.py b/_unittests/ut_serverdoc/test_documentation_server.py index 980188138..34b74fb8f 100644 --- a/_unittests/ut_serverdoc/test_documentation_server.py +++ b/_unittests/ut_serverdoc/test_documentation_server.py @@ -10,7 +10,7 @@ from http.server import HTTPServer as skip_ from pyquickhelper.loghelper import fLOG, get_url_content -from pyquickhelper.serverdoc import run_doc_server +from pyquickhelper.server import run_doc_server from pyquickhelper.pycode import skipif_appveyor, ExtTestCase diff --git a/_unittests/ut_serverdoc/test_mappings.py b/_unittests/ut_serverdoc/test_mappings.py index bd618ca68..59eaf42cf 100644 --- a/_unittests/ut_serverdoc/test_mappings.py +++ b/_unittests/ut_serverdoc/test_mappings.py @@ -9,7 +9,7 @@ import unittest from pyquickhelper.loghelper import fLOG -from pyquickhelper.serverdoc import get_jenkins_mappings +from pyquickhelper.server import get_jenkins_mappings class TestMappings(unittest.TestCase): diff --git a/_unittests/ut_sphinxext/data/html_example2.txt b/_unittests/ut_sphinxext/data/html_example2.txt index d4d9c1426..8e35f47b6 100644 --- a/_unittests/ut_sphinxext/data/html_example2.txt +++ b/_unittests/ut_sphinxext/data/html_example2.txt @@ -343,14 +343,14 @@ to display it in a notebook.

run a local server which serves the documentation

The following code will create a local server: http://localhost:8079/pyquickhelper/.

-
this_fold = os.path.dirname(pyquickhelper.serverdoc.documentation_server.__file__)
+
this_fold = os.path.dirname(pyquickhelper.server.documentation_server.__file__)
 this_path = os.path.abspath( os.path.join( this_fold, "..", "..", "..", "dist", "html") )
 run_doc_server(None, mappings = { "pyquickhelper": this_path } )
 

 

 
The same server can serves more than one project.
 More than one mappings can be sent.

-
see file documentation_server.py

+
see file documentation_server.py

Run a notebook end to end

diff --git a/src/pyquickhelper/pycode/build_helper.py b/src/pyquickhelper/pycode/build_helper.py index f324f5723..a74d3c70d 100644 --- a/src/pyquickhelper/pycode/build_helper.py +++ b/src/pyquickhelper/pycode/build_helper.py @@ -445,7 +445,7 @@ def get_script_module(command, platform=sys.platform, blog_list=None, script.append(("auto_doc_server.py", prefix_setup + """ # address http://localhost:8079/ from pyquickhelper import fLOG - from pyquickhelper.serverdoc import run_doc_server, get_jenkins_mappings + from pyquickhelper.server import run_doc_server, get_jenkins_mappings fLOG(OutputPrint=True) fLOG("running documentation server") thisfile = os.path.dirname(__file__) diff --git a/src/pyquickhelper/serverdoc/__init__.py b/src/pyquickhelper/server/__init__.py similarity index 100% rename from src/pyquickhelper/serverdoc/__init__.py rename to src/pyquickhelper/server/__init__.py diff --git a/src/pyquickhelper/serverdoc/documentation_server.py b/src/pyquickhelper/server/documentation_server.py similarity index 99% rename from src/pyquickhelper/serverdoc/documentation_server.py rename to src/pyquickhelper/server/documentation_server.py index 81d64e6f7..6d26f616a 100644 --- a/src/pyquickhelper/serverdoc/documentation_server.py +++ b/src/pyquickhelper/server/documentation_server.py @@ -559,7 +559,7 @@ def run_doc_server(server, mappings, thread=False, port=8079): :: - this_fold = os.path.dirname(pyquickhelper.serverdoc.documentation_server.__file__) + this_fold = os.path.dirname(pyquickhelper.server.documentation_server.__file__) this_path = os.path.abspath( os.path.join( this_fold, "..", "..", "..", "dist", "html") ) run_doc_server(None, mappings = { "pyquickhelper": this_path } ) diff --git a/src/pyquickhelper/serverdoc/server_helper.py b/src/pyquickhelper/server/server_helper.py similarity index 100% rename from src/pyquickhelper/serverdoc/server_helper.py rename to src/pyquickhelper/server/server_helper.py