Updated documentation scripts

Signed-off-by: Omkar Phansopkar <omkarphansopkar@gmail.com>
aboutcode-org · Oct 2, 2023 · 9eadc37 · 9eadc37
1 parent bc838c5
commit 9eadc37
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 9 deletions.
diff --git a/docs/Makefile b/docs/Makefile
@@ -16,9 +16,9 @@ help:
 .PHONY: help Makefile
 
 # Run the development server using sphinx-autobuild
-dev:
+docs:
 	@echo
-	@echo "Starting up the dev docs server..."
+	@echo "Starting up the docs server..."
 	@echo
 	$(SPHINXAUTOBUILD) --port 8000 --watch ${SOURCEDIR} $(SOURCEDIR) "$(BUILDDIR)/html" $(SPHINXOPTS) $(O)
 

diff --git a/docs/README.md b/docs/README.md
@@ -7,9 +7,9 @@ $ source venv/bin/activate
 $ pip install -r requirements.txt
 ```
 
-Run Sphinx documentation server in dev mode:
+Run Sphinx documentation server:
 ```
-$ make dev
+$ make docs
 ```
 
 Build Sphinx documentation

diff --git a/docs/make.bat b/docs/make.bat
@@ -15,7 +15,7 @@ set BUILDDIR=build
 
 if "%1" == "" goto help
 
-if "%1" == "dev" goto dev
+if "%1" == "docs" goto docs
 
 %SPHINXBUILD% >NUL 2>NUL
 if errorlevel 9009 (
@@ -33,9 +33,9 @@ if errorlevel 9009 (
 %SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
 goto end
 
-:dev
+:docs
 @echo
-@echo Starting up the dev docs server...
+@echo Starting up the docs server...
 @echo
 %SPHINXAUTOBUILD% --port 8000 --watch %SOURCEDIR% %SOURCEDIR% %BUILDDIR%\html %SPHINXOPTS% %O%
 goto end

diff --git a/docs/source/contribute/building.rst b/docs/source/contribute/building.rst
@@ -101,5 +101,5 @@ Create python environment, make docs
    # Build Documentation
    $ make html
 
-   # Run Documentation server in dev mode
-   $ make dev
+   # Run Documentation server
+   $ make docs