mirror of
https://github.com/cytopia/devilbox.git
synced 2025-01-18 02:40:04 +00:00
Fix external links
This commit is contained in:
parent
2662566677
commit
0121371048
1
.gitignore
vendored
1
.gitignore
vendored
@ -82,7 +82,6 @@ docker-compose.override.yml
|
||||
# Ignore documentation sphinx build
|
||||
/docs/_build/
|
||||
/docs/make.bat
|
||||
/docs/Makefile
|
||||
*.rst.todo
|
||||
|
||||
# Keep folders
|
||||
|
@ -185,7 +185,8 @@ before_script:
|
||||
script:
|
||||
- if [ "${S1}" = "DOCUMENTATION" ]; then
|
||||
cd docs/;
|
||||
sphinx-build -a -W -E -j auto -n -v . _build/html/;
|
||||
make build;
|
||||
make linkcheck;
|
||||
else
|
||||
.tests/test_single.sh . "${S1}" "${V1}" "${S2}" "${V2}";
|
||||
fi
|
||||
|
56
docs/Makefile
Normal file
56
docs/Makefile
Normal file
@ -0,0 +1,56 @@
|
||||
# Minimal makefile for Sphinx documentation
|
||||
#
|
||||
|
||||
# You can set these variables from the command line.
|
||||
SPHINXOPTS =
|
||||
SPHINXBUILD = sphinx-build
|
||||
SPHINXPROJ = devilbox
|
||||
SOURCEDIR = .
|
||||
BUILDDIR = _build
|
||||
|
||||
# Put it first so that "make" without argument is like "make help".
|
||||
help:
|
||||
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|
||||
@echo
|
||||
@echo "Devilbox additional commands:"
|
||||
@echo " build Build and test documentation"
|
||||
@echo " autobuild Continuously run and build (http://127.0.0.1:8000)"
|
||||
|
||||
.PHONY: help Makefile test build autobuild
|
||||
|
||||
# Catch-all target: route all unknown targets to Sphinx using the new
|
||||
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
|
||||
%: Makefile
|
||||
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|
||||
|
||||
|
||||
#
|
||||
# Devilbox additions
|
||||
#
|
||||
#
|
||||
# Used Sphinx options:
|
||||
# --------------------
|
||||
#
|
||||
# -a: Always write all output files. The default is to only write output files
|
||||
# for new and changed source files.
|
||||
#
|
||||
# -E: Don’t use a saved environment (the structure caching all cross-references),
|
||||
# but rebuild it completely.
|
||||
#
|
||||
# -n: Run in nit-picky mode. Currently, this generates warnings for all
|
||||
# missing references. See the config value nitpick_ignore for a way to
|
||||
# exclude some references as “known missing”.
|
||||
#
|
||||
# -q: Do not output anything on standard output, only write warnings and errors
|
||||
# to standard error.
|
||||
#
|
||||
# -W: Turn warnings into errors. This means that the build stops at the first
|
||||
# warning and sphinx-build exits with exit status 1.
|
||||
|
||||
|
||||
|
||||
build:
|
||||
sphinx-build -a -E -n -j auto -q -W . _build/html
|
||||
|
||||
autobuild:
|
||||
sphinx-autobuild -E -n -j auto . _build/html
|
13
docs/conf.py
13
docs/conf.py
@ -81,6 +81,19 @@ exclude_patterns = [u'_build', 'Thumbs.db', '.DS_Store']
|
||||
pygments_style = 'sphinx'
|
||||
|
||||
|
||||
# -- Options for Link check -------------------------------------------------
|
||||
|
||||
# http://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-the-linkcheck-builder
|
||||
linkcheck_ignore = [
|
||||
r'http(s)?://localhost(/)?.*',
|
||||
r'http(s)?://127\.0\.0\.1(/)?.*',
|
||||
r'http(s)?://.+\.loc$'
|
||||
]
|
||||
linkcheck_retries = 5
|
||||
linkcheck_timeout = 60
|
||||
linkcheck_anchors = True
|
||||
|
||||
|
||||
# -- Options for HTML output -------------------------------------------------
|
||||
|
||||
# The theme to use for HTML and HTML Help pages. See the documentation for
|
||||
|
@ -93,7 +93,7 @@ Change child process on pool ``www`` for PHP 5.6
|
||||
|
||||
The following examples shows you how to change the
|
||||
`pm <https://secure.php.net/manual/en/install.fpm.configuration.php#pm>`_,
|
||||
`pm.max_children <https://secure.php.net/manual/en/install.fpm.configuration.php#pm.max-chidlren>`_,
|
||||
`pm.max_children <https://secure.php.net/manual/en/install.fpm.configuration.php#pm.max-children>`_,
|
||||
`pm.start_servers <https://secure.php.net/manual/en/install.fpm.configuration.php#pm.start-servers>`_,
|
||||
`pm.min_spare_servers <https://secure.php.net/manual/en/install.fpm.configuration.php#pm.min-spare-servers>`_
|
||||
and
|
||||
|
@ -143,7 +143,7 @@ Once done, you can verify if the new DNS settings are effective:
|
||||
|
||||
host> systemd-resolve --status
|
||||
|
||||
.. seealso:: `Archlinux Wiki: resolv.conf <https://wiki.archlinux.org/index.php/Resolv.conf#Modify_the_dhcpcd_config>`_
|
||||
.. seealso:: `Archlinux Wiki: resolv.conf <https://wiki.archlinux.org/index.php/Dhcpcd#resolv.conf>`_
|
||||
|
||||
|
||||
MacOS
|
||||
|
@ -6,7 +6,7 @@ Setup Yii
|
||||
|
||||
This example will use ``composer`` to install Yii from within the PHP container.
|
||||
|
||||
.. seealso:: `Official Yii Documentation <http://www.yiiframework.com/doc-2.0/guide-start-installation.html>`_
|
||||
.. seealso:: `Official Yii Documentation <https://www.yiiframework.com/doc/guide/2.0/en/start-installation>`_
|
||||
|
||||
|
||||
**Table of Contents**
|
||||
|
@ -24,7 +24,7 @@ Install Docker
|
||||
Docker on Linux
|
||||
---------------
|
||||
|
||||
Refer to the official `Docker for Linux documentation <https://docs.docker.com/engine/installation/#supported-platforms>`_ for how to install ``Docker`` on your specific Linux distribution.
|
||||
Refer to the official `Docker for Linux documentation <https://docs.docker.com/install/#supported-platforms>`_ for how to install ``Docker`` on your specific Linux distribution.
|
||||
|
||||
Docker on Windows
|
||||
-----------------
|
||||
|
@ -48,7 +48,7 @@ The PHP container is your workhorse and these are your tools:
|
||||
+----------------------+-----------------------------------------------------------------------------------+
|
||||
| ``mysqldump-secure`` | `mysqldump-secure <https://mysqldump-secure.org>`_ |
|
||||
+----------------------+-----------------------------------------------------------------------------------+
|
||||
| ``node`` | `Node <https://nodejs.org>`_ |
|
||||
| ``node`` | `Node <https://nodejs.org/en/>`_ |
|
||||
+----------------------+-----------------------------------------------------------------------------------+
|
||||
| ``npm`` | `NPM <https://www.npmjs.com>`_ |
|
||||
+----------------------+-----------------------------------------------------------------------------------+
|
||||
|
@ -94,7 +94,7 @@ ESLint
|
||||
|
||||
ESLint is a Javascript static source code analyzer.
|
||||
|
||||
.. seealso:: `ESLint <http://eslint.org>`_
|
||||
.. seealso:: `ESLint <https://eslint.org>`_
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user