From 85ee3c921a18c40e655dbdf15c2792e6740e5f50 Mon Sep 17 00:00:00 2001 From: Andrew Chen Wang <60190294+Andrew-Chen-Wang@users.noreply.github.com> Date: Sun, 13 Feb 2022 07:49:05 -0500 Subject: [PATCH] Change docs port to 9000 from 7000 (#3590) Signed-off-by: Andrew-Chen-Wang --- docs/document.rst | 4 ++-- {{cookiecutter.project_slug}}/docs/Makefile | 8 ++++---- {{cookiecutter.project_slug}}/docs/make.bat | 2 +- {{cookiecutter.project_slug}}/local.yml | 2 +- 4 files changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/document.rst b/docs/document.rst index a3097909..974c66c6 100644 --- a/docs/document.rst +++ b/docs/document.rst @@ -13,7 +13,7 @@ If you set up your project to `develop locally with docker`_, run the following $ docker-compose -f local.yml up docs -Navigate to port 7000 on your host to see the documentation. This will be opened automatically at `localhost`_ for local, non-docker development. +Navigate to port 9000 on your host to see the documentation. This will be opened automatically at `localhost`_ for local, non-docker development. Note: using Docker for documentation sets up a temporary SQLite file by setting the environment variable ``DATABASE_URL=sqlite:///readthedocs.db`` in ``docs/conf.py`` to avoid a dependency on PostgreSQL. @@ -36,7 +36,7 @@ To setup your documentation on `ReadTheDocs`_, you must Additionally, you can auto-build Pull Request previews, but `you must enable it`_. -.. _localhost: http://localhost:7000/ +.. _localhost: http://localhost:9000/ .. _Sphinx: https://www.sphinx-doc.org/en/master/index.html .. _develop locally: ./developing-locally.html .. _develop locally with docker: ./developing-locally-docker.html diff --git a/{{cookiecutter.project_slug}}/docs/Makefile b/{{cookiecutter.project_slug}}/docs/Makefile index 0c4f9f57..cf080e47 100644 --- a/{{cookiecutter.project_slug}}/docs/Makefile +++ b/{{cookiecutter.project_slug}}/docs/Makefile @@ -3,7 +3,7 @@ # You can set these variables from the command line, and also # from the environment for the first two. -SPHINXOPTS ?= +SPHINXOPTS ?= SPHINXBUILD ?= sphinx-build SOURCEDIR = . BUILDDIR = ./_build @@ -21,10 +21,10 @@ help: # Build, watch and serve docs with live reload livehtml: - sphinx-autobuild -b html + sphinx-autobuild -b html {%- if cookiecutter.use_docker == 'y' %} --host 0.0.0.0 - {%- else %} --open-browser - {%- endif %} --port 7000 --watch $(APP) -c . $(SOURCEDIR) $(BUILDDIR)/html + {%- else %} --open-browser + {%- endif %} --port 9000 --watch $(APP) -c . $(SOURCEDIR) $(BUILDDIR)/html # Outputs rst files from django application code apidocs: diff --git a/{{cookiecutter.project_slug}}/docs/make.bat b/{{cookiecutter.project_slug}}/docs/make.bat index b19f42c6..6cd1129f 100644 --- a/{{cookiecutter.project_slug}}/docs/make.bat +++ b/{{cookiecutter.project_slug}}/docs/make.bat @@ -32,7 +32,7 @@ if errorlevel 9009 ( goto end :livehtml -sphinx-autobuild -b html --open-browser -p 7000 --watch %APP% -c . %SOURCEDIR% %BUILDDIR%/html +sphinx-autobuild -b html --open-browser -p 9000 --watch %APP% -c . %SOURCEDIR% %BUILDDIR%/html GOTO :EOF :apidocs diff --git a/{{cookiecutter.project_slug}}/local.yml b/{{cookiecutter.project_slug}}/local.yml index 78e390a8..59044582 100644 --- a/{{cookiecutter.project_slug}}/local.yml +++ b/{{cookiecutter.project_slug}}/local.yml @@ -55,7 +55,7 @@ services: - ./config:/app/config:z - ./{{ cookiecutter.project_slug }}:/app/{{ cookiecutter.project_slug }}:z ports: - - "7000:7000" + - "9000:9000" command: /start-docs {%- if cookiecutter.use_mailhog == 'y' %}