Skip to content

Commit bb36df7

Browse files
tinprojectThibaut
authored andcommitted
Fix and upgrade Ansible doc
1 parent 4714060 commit bb36df7

2 files changed

Lines changed: 34 additions & 13 deletions

File tree

lib/docs/filters/ansible/entries.rb

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,14 +11,28 @@ def get_name
1111
end
1212

1313
def get_type
14-
if slug.include?('module')
15-
if name =~ /\A[a-z]/ && node = css('.toctree-l2.current').last
16-
"Modules: #{node.content.remove(' Modules')}"
14+
if slug =~ /\Acli\//
15+
'CLI Reference'
16+
elsif slug =~ /\Anetwork\//
17+
'Network'
18+
elsif slug =~ /\Aplugins\//
19+
if name =~ /\A[a-z]/ && node = css('.toctree-l3.current').last
20+
"Plugins: #{node.content.sub(/ Plugins.*/, '')}"
1721
else
22+
'Plugins'
23+
end
24+
elsif slug =~ /\Amodules\//
25+
if slug =~ /\Amodules\/list_/ || slug=~ /_maintained\z/
1826
'Modules'
27+
else
28+
'Modules: Index'
1929
end
2030
elsif slug.include?('playbook')
2131
'Playbooks'
32+
elsif slug =~ /\Auser_guide\//
33+
'Guides: User'
34+
elsif slug =~ /\Ascenario_guides\//
35+
'Guides: Scenarios'
2236
elsif slug.include?('guide')
2337
'Guides'
2438
else

lib/docs/scrapers/ansible.rb

Lines changed: 17 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -7,25 +7,32 @@ class Ansible < UrlScraper
77
code: 'https://github.com/ansible/ansible'
88
}
99

10-
html_filters.push 'ansible/entries', 'sphinx/clean_html'
10+
html_filters.push 'ansible/entries', 'sphinx/clean_html', 'ansible/clean_html'
1111

1212
options[:skip] = %w(
13-
glossary.html
14-
faq.html
15-
community.html
16-
tower.html
17-
quickstart.html
18-
list_of_all_modules.html)
13+
installation_guide/index.html
14+
reference_appendices/glossary.html
15+
reference_appendices/faq.html
16+
reference_appendices/tower.html
17+
user_guide/quickstart.html
18+
modules/modules_by_category.html
19+
modules/list_of_all_modules.html)
20+
21+
options[:skip_patterns] = [
22+
/\Acommunity.*/i,
23+
/\Adev_guide.*/i,
24+
/\Aroadmap.*/i,
25+
]
1926

2027
options[:attribution] = <<-HTML
2128
&copy; 2012&ndash;2018 Michael DeHaan<br>
2229
&copy; 2018 Red Hat, Inc.<br>
2330
Licensed under the GNU General Public License version 3.
2431
HTML
2532

26-
version '2.4' do
27-
self.release = '2.4.3'
28-
self.base_url = 'https://docs.ansible.com/ansible/2.4/'
33+
version '2.5' do
34+
self.release = '2.5.3'
35+
self.base_url = 'https://docs.ansible.com/ansible/2.5/'
2936
end
3037
end
3138
end

0 commit comments

Comments
 (0)