centersl/ansible-docs
1
0
Fork 0
mirror of https://github.com/ansible/ansible-documentation.git synced 2026-03-27 13:28:51 +07:00
Code Issues Packages Projects Releases Wiki Activity

Fix "Edit on GitHub" links for CLI programs (#188)

Browse Source
This commit is contained in:
Matt Clay
2023-07-28 13:07:43 -07:00
committed by GitHub
parent 1b48103211
commit eb4dc6c59e
8 changed files with 13 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/docsite/.templates/breadcrumbs.html
View File

@@ -15,7 +15,7 @@
<br>
{% elif check_meta and pagename.startswith('cli') and meta.get('source', None) %}
<a href="https://{{ github_host|default("github.com") }}/{{ github_user }}/{{ github_repo }}/{{ theme_vcs_pageview_mode or "blob" }}/{{ github_cli_version }}{{ meta.get('source', '') }}?description=%23%23%23%23%23%20SUMMARY%0A%3C!---%20Your%20description%20here%20--%3E%0A%0A%0A%23%23%23%23%23%20ISSUE%20TYPE%0A-%20Docs%20Pull%20Request%0A%0A%2Blabel:%20docsite_pr" class="fa fa-github"> {{ _('Edit on GitHub') }}</a>
<a href="https://{{ github_host|default("github.com") }}/{{ github_user }}/{{ github_cli_repo }}/{{ theme_vcs_pageview_mode or "blob" }}/{{ github_cli_version }}/{{ meta.get('source', '') }}?description=%23%23%23%23%23%20SUMMARY%0A%3C!---%20Your%20description%20here%20--%3E%0A%0A%0A%23%23%23%23%23%20ISSUE%20TYPE%0A-%20Docs%20Pull%20Request%0A%0A%2Blabel:%20docsite_pr" class="fa fa-github"> {{ _('Edit on GitHub') }}</a>
{% elif (not 'list_of' in pagename) and (not 'category' in pagename) %}
<a href="https://{{ github_host|default("github.com") }}/{{ github_user }}/{{ github_repo }}/{{ theme_vcs_pageview_mode or "blob" }}/{{ github_version }}{{ conf_py_path }}{{ pagename }}{{ page_source_suffix }}?description=%23%23%23%23%23%20SUMMARY%0A%3C!---%20Your%20description%20here%20--%3E%0A%0A%0A%23%23%23%23%23%20ISSUE%20TYPE%0A-%20Docs%20Pull%20Request%0A%0A%2Blabel:%20docsite_pr" class="fa fa-github"> {{ _('Edit on GitHub') }}</a>
{% endif %}

3
docs/docsite/sphinx_conf/2.10_conf.py
View File

@@ -156,7 +156,8 @@ html_context = {
'github_version': 'devel/docs/docsite/rst/',
'github_module_version': 'devel/lib/ansible/modules/',
'github_root_dir': 'devel/lib/ansible',
'github_cli_version': 'devel/lib/ansible/cli/',
'github_cli_repo': 'ansible',
'github_cli_version': 'devel',
'current_version': version,
'latest_version': '2.10',
# list specifically out of order to make latest work

3
docs/docsite/sphinx_conf/all_conf.py
View File

@@ -152,7 +152,8 @@ html_context = {
'github_version': 'devel/docs/docsite/rst/',
'github_module_version': 'devel/lib/ansible/modules/',
'github_root_dir': 'devel/lib/ansible',
'github_cli_version': 'devel/lib/ansible/cli/',
'github_cli_repo': 'ansible',
'github_cli_version': 'devel',
'current_version': version,
'latest_version': 'devel',
# list specifically out of order to make latest work

3
docs/docsite/sphinx_conf/ansible_conf.py
View File

@@ -162,7 +162,8 @@ html_context = {
'github_version': 'devel/docs/docsite/rst/',
'github_module_version': 'devel/lib/ansible/modules/',
'github_root_dir': 'devel/lib/ansible',
'github_cli_version': 'devel/lib/ansible/cli/',
'github_cli_repo': 'ansible',
'github_cli_version': 'devel',
'current_version': version,
'latest_version': '8',
# list specifically out of order to make latest work

3
docs/docsite/sphinx_conf/core_conf.py
View File

@@ -205,7 +205,8 @@ html_context = {
'github_version': 'devel/docs/docsite/rst/',
'github_module_version': 'devel/lib/ansible/modules/',
'github_root_dir': 'devel/lib/ansible',
'github_cli_version': 'devel/lib/ansible/cli/',
'github_cli_repo': 'ansible',
'github_cli_version': 'devel',
'current_version': version,
'latest_version': '2.15',
# list specifically out of order to make latest work

3
docs/docsite/sphinx_conf/core_lang_conf.py
View File

@@ -205,7 +205,8 @@ html_context = {
'github_version': 'devel/docs/docsite/rst/',
'github_module_version': 'devel/lib/ansible/modules/',
'github_root_dir': 'devel/lib/ansible',
'github_cli_version': 'devel/lib/ansible/cli/',
'github_cli_repo': 'ansible',
'github_cli_version': 'devel',
'current_version': version,
'latest_version': '2.15',
# list specifically out of order to make latest work

2
docs/templates/cli_rst.j2 vendored
View File

@@ -1,4 +1,4 @@
:source: {{ cli }}.py
:source: {{ source }}
{% set name = cli_name -%}
{% set name_slug = cli_name -%}

3
hacking/build_library/build_ansible/command_plugins/generate_man.py
View File

@@ -129,7 +129,7 @@ def opts_docs(cli_class_name, cli_module_name):
# base/common cli info
cli_options = opt_doc_list(cli.parser)
docs = {
'cli': cli_module_name,
'source': f'lib/ansible/cli/{cli_module_name}.py',
'cli_name': cli_name,
'usage': cli.parser.format_usage(),
'short_desc': cli.parser.description,
@@ -289,7 +289,6 @@ class GenerateMan(Command):
# add rest to vars
tvars = allvars[cli_name]
tvars['cli_bin_name_list'] = cli_bin_name_list
tvars['cli'] = cli_name
if '-i' in tvars['option_names']:
tvars['inventory'] = True
print('uses inventory')