yard-to_mkdocs 0.1.0 → 0.1.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +16 -2
- data/Gemfile.lock +2 -1
- data/lib/yard/to_mkdocs/default/fulldoc/html/setup.rb +2 -2
- data/lib/yard/to_mkdocs/version.rb +1 -1
- metadata +2 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 06f16153b27f1affa449a6b0fcd189a12d1bf092ca3d867a1837b5134b21ee1f
|
|
4
|
+
data.tar.gz: 1f790f55e1ba7941eec184f190c4e3667ffb7d03dee2967db6e7ed552652e565
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: b28dc98d69ef6b2f4bde495fa4c715804998fed6a90d009522dabc27485111feac15d9bf425d080cb64602d15b352851350de1101bc8f358720ac8b818b532b3
|
|
7
|
+
data.tar.gz: 2ee225e2068965eecaa19d401fdd0873d3ae9d7fe808452aea6944e6dcfa59c96d16ddf223e532fb0409d1623f49bf7fe139978924d1bc697899747a39255709
|
data/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,19 @@
|
|
|
1
|
-
|
|
1
|
+
# Changelog for `yard-to_mkdocs`
|
|
2
|
+
All notable changes to this project will be documented in this file.
|
|
2
3
|
|
|
3
|
-
|
|
4
|
+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
|
5
|
+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
## [0.1.1] - 2022-05-31
|
|
9
|
+
### Added
|
|
10
|
+
- Respect the title given for the root directory name in mkdocs navigation
|
|
4
11
|
|
|
12
|
+
### Removed
|
|
13
|
+
- Removed hardcoding of output directory to allow for multiple renderings
|
|
14
|
+
|
|
15
|
+
## [0.1.0] - 2022-05-09
|
|
5
16
|
- Initial release
|
|
17
|
+
|
|
18
|
+
[0.1.1]: https://github.com/Invoca/yard-to_mkdocs/compare/v0.1.0...v0.1.1
|
|
19
|
+
[0.1.0]: https://github.com/Invoca/yard-to_mkdocs/releases/tag/v0.1.0
|
data/Gemfile.lock
CHANGED
|
@@ -5,7 +5,6 @@ require 'yaml'
|
|
|
5
5
|
include Helpers::ModuleHelper
|
|
6
6
|
|
|
7
7
|
def init
|
|
8
|
-
options.serializer.basepath = 'docs/yard_docs'
|
|
9
8
|
options.serializer.extension = 'md'
|
|
10
9
|
|
|
11
10
|
options.objects = objects = run_verifier(options.objects)
|
|
@@ -29,10 +28,11 @@ def init
|
|
|
29
28
|
end
|
|
30
29
|
|
|
31
30
|
mkdocs_file_path = File.expand_path('../../mkdocs.yml', options.serializer.basepath)
|
|
31
|
+
root_path = options.serializer.basepath.split('/')[1..-1].join('/')
|
|
32
32
|
if File.exists?(mkdocs_file_path)
|
|
33
33
|
mkdocs_yaml = YAML.load_file(mkdocs_file_path)
|
|
34
34
|
mkdocs_nav = mkdocs_yaml['nav'].reject { |item| item["YARD Docs"] }
|
|
35
|
-
mkdocs_yaml['nav'] = mkdocs_nav + [{
|
|
35
|
+
mkdocs_yaml['nav'] = mkdocs_nav + [{ options[:title] => mkdocs_nav_tree(objects.first, root_path) }]
|
|
36
36
|
File.open(mkdocs_file_path, 'w') { |f| f.write(mkdocs_yaml.to_yaml) }
|
|
37
37
|
end
|
|
38
38
|
end
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: yard-to_mkdocs
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.1.
|
|
4
|
+
version: 0.1.1
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Octothope
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: exe
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2022-05-
|
|
11
|
+
date: 2022-05-31 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: yard
|