Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adds custom 404 with cowsay image #57422

Open
wants to merge 10 commits into
base: devel
from

Conversation

Projects
None yet
2 participants
@acozine
Copy link
Contributor

commented Jun 5, 2019

SUMMARY

Prerequisite for #55655.

Fixes #51439.

Adds a custom 404 page to the docsite. Needs more testing before we merge.

ISSUE TYPE
  • Docs Pull Request
COMPONENT NAME

docs.ansible.com/ansible

@ansibot

This comment was marked as resolved.

Copy link
Contributor

commented Jun 5, 2019

The test ansible-test sanity --test docs-build [explain] failed with the error:

Command "/usr/bin/python3.6 test/sanity/code-smell/docs-build.py" returned exit status 1.
>>> Standard Error
Command 'make singlehtmldocs' failed with status code: 2
--> Standard Output
PYTHONPATH=../../lib ../bin/dump_config.py --template-file=../templates/config.rst.j2 --output-dir=rst/reference_appendices/ -d ../../lib/ansible/config/base.yml
mkdir -p rst/cli
PYTHONPATH=../../lib ../bin/generate_man.py --template-file=../templates/cli_rst.j2 --output-dir=rst/cli/ --output-format rst ../../lib/ansible/cli/*.py
PYTHONPATH=../../lib ../bin/dump_keywords.py --template-dir=../templates --output-dir=rst/reference_appendices/ -d ./keyword_desc.yml
PYTHONPATH=../../lib ../bin/plugin_formatter.py -t rst --template-dir=../templates --module-dir=../../lib/ansible/modules -o rst/modules/ 
Evaluating module files...
rendering: idrac_firmware (2876 previous rendering line(s) omitted)
*** recording category all in list_of_all_modules.rst ***
rendering: None
*** recording category cloud in list_of_cloud_modules.rst ***
rendering: None
*** recording category clustering in list_of_clustering_modules.rst ***
rendering: None
*** recording category commands in list_of_commands_modules.rst ***
rendering: None
*** recording category crypto in list_of_crypto_modules.rst ***
rendering: None
*** recording category database in list_of_database_modules.rst ***
rendering: None
*** recording category files in list_of_files_modules.rst ***
rendering: None
*** recording category identity in list_of_identity_modules.rst ***
rendering: None
*** recording category inventory in list_of_inventory_modules.rst ***
rendering: None
*** recording category messaging in list_of_messaging_modules.rst ***
rendering: None
*** recording category monitoring in list_of_monitoring_modules.rst ***
rendering: None
*** recording category net_tools in list_of_net_tools_modules.rst ***
rendering: None
*** recording category network in list_of_network_modules.rst ***
rendering: None
*** recording category notification in list_of_notification_modules.rst ***
rendering: None
*** recording category packaging in list_of_packaging_modules.rst ***
rendering: None
*** recording category remote_management in list_of_remote_management_modules.rst ***
rendering: None
*** recording category source_control in list_of_source_control_modules.rst ***
rendering: None
*** recording category storage in list_of_storage_modules.rst ***
rendering: None
*** recording category system in list_of_system_modules.rst ***
rendering: None
*** recording category utilities in list_of_utilities_modules.rst ***
rendering: None
*** recording category web_infrastructure in list_of_web_infrastructure_modules.rst ***
rendering: None
*** recording category windows in list_of_windows_modules.rst ***
rendering: None (4 previous rendering line(s) omitted)
looping over doc plugins
for plugin in become cache callback cliconf connection httpapi inventory lookup shell strategy vars; \
do \
	PYTHONPATH=../../lib ../bin/plugin_formatter.py -t rst --plugin-type $plugin --template-dir=../templates --module-dir=../../lib/ansible/plugins/$plugin -o rst ; \
done
Evaluating become files...
rendering: enable (11 previous rendering line(s) omitted)
Evaluating cache files...
rendering: yaml (6 previous rendering line(s) omitted)
Evaluating callback files...
rendering: log_plays (39 previous rendering line(s) omitted)
Evaluating cliconf files...
rendering: exos (25 previous rendering line(s) omitted)
Evaluating connection files...
rendering: ssh (25 previous rendering line(s) omitted)
Evaluating httpapi files...
rendering: exos (8 previous rendering line(s) omitted)
Evaluating inventory files...
rendering: yaml (30 previous rendering line(s) omitted)
Evaluating lookup files...
rendering: url (61 previous rendering line(s) omitted)
Evaluating shell files...
rendering: fish (4 previous rendering line(s) omitted)
Evaluating strategy files...
rendering: host_pinned (3 previous rendering line(s) omitted)
Evaluating vars files...
rendering: host_group_vars
../bin/testing_formatter.sh
CPUS=2 make -f Makefile.sphinx singlehtml
make[1]: Entering directory '/root/ansible/docs/docsite'
sphinx-build -M singlehtml "rst" "_build" -j 2 -n -w rst_warnings 
Running Sphinx v1.7.9
Makefile.sphinx:24: recipe for target 'singlehtml' failed
make[1]: Leaving directory '/root/ansible/docs/docsite'
Makefile:46: recipe for target 'singlehtmldocs' failed
--> Standard Error
../bin/testing_formatter.sh: line 24: ../docsite/rst/dev_guide/testing/sanity/index.rst: No such file or directory

Extension error:
Could not import extension notfound.extension (exception: No module named 'notfound')
make[1]: *** [singlehtml] Error 2
make: *** [singlehtmldocs] Error 2

click here for bot help

@ansibot

This comment has been minimized.

Copy link
Contributor

commented Jun 5, 2019

@ansibot ansibot added the test label Jun 5, 2019

@acozine acozine added the ci_verified label Jun 5, 2019

@acozine

This comment has been minimized.

Copy link
Contributor Author

commented Jun 5, 2019

I'll fix the not-in-toctree error. The other two sphinx errors should be fixed once rtfd/sphinx-notfound-page#44 is merged.

@ansibot

This comment has been minimized.

Copy link
Contributor

commented Jun 5, 2019

The test ansible-test sanity --test docs-build [explain] failed with 3 errors:

docs/docsite/rst/404.rst:0:0: not-in-toc-tree: document isn't included in any toctree
docs/docsite/rst/index.rst:0:0: unknown: WARNING: doing serial read
docs/docsite/rst/index.rst:0:0: unknown: WARNING: the notfound.extension extension does not declare if it is safe for parallel reading, assuming it isn't - please ask the extension author to check and make it explicit

click here for bot help

@ansibot ansibot removed the ci_verified label Jun 5, 2019

@ansibot

This comment has been minimized.

Copy link
Contributor

commented Jun 5, 2019

The test ansible-test sanity --test docs-build [explain] failed with 3 errors:

docs/docsite/rst/404.rst:15:0: explicit-markup-missing-blank-line: Explicit markup ends without a blank line; unexpected unindent.
docs/docsite/rst/index.rst:0:0: unknown: WARNING: doing serial read
docs/docsite/rst/index.rst:0:0: unknown: WARNING: the notfound.extension extension does not declare if it is safe for parallel reading, assuming it isn't - please ask the extension author to check and make it explicit

The test ansible-test sanity --test rstcheck [explain] failed with 1 error:

docs/docsite/rst/404.rst:15:0: Explicit markup ends without a blank line; unexpected unindent.

click here for bot help

@ansibot

This comment has been minimized.

Copy link
Contributor

commented Jun 5, 2019

The test ansible-test sanity --test docs-build [explain] failed with 2 errors:

docs/docsite/rst/index.rst:0:0: unknown: WARNING: doing serial read
docs/docsite/rst/index.rst:0:0: unknown: WARNING: the notfound.extension extension does not declare if it is safe for parallel reading, assuming it isn't - please ask the extension author to check and make it explicit

click here for bot help

@ansibot

This comment has been minimized.

Copy link
Contributor

commented Jun 10, 2019

The test ansible-test sanity --test docs-build [explain] failed with 2 errors:

docs/docsite/rst/index.rst:0:0: unknown: WARNING: doing serial read
docs/docsite/rst/index.rst:0:0: unknown: WARNING: the notfound.extension extension does not declare if it is safe for parallel reading, assuming it isn't - please ask the extension author to check and make it explicit

click here for bot help

@ansibot

This comment has been minimized.

Copy link
Contributor

commented Jun 11, 2019

The test ansible-test sanity --test docs-build [explain] failed with 2 errors:

docs/docsite/rst/index.rst:0:0: unknown: WARNING: doing serial read
docs/docsite/rst/index.rst:0:0: unknown: WARNING: the notfound.extension extension does not declare if it is safe for parallel reading, assuming it isn't - please ask the extension author to check and make it explicit

click here for bot help

@acozine acozine changed the title WIP: Adds text-only custom 404 and image for future use Adds custom 404 with cowsay image Jun 14, 2019

@ansibot ansibot added core_review and removed WIP labels Jun 14, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.