OpenSourceArk/mkdocs-material
1
0
Fork 0
mirror of https://github.com/squidfunk/mkdocs-material.git synced 2024-06-14 11:52:32 +03:00
Code Issues Packages Projects Releases Wiki Activity

Raise error in tags plugin when tags file does not exist

Browse Source
This commit is contained in:
squidfunk 2022-03-26 14:14:00 +01:00
parent 6322ecef42
commit dfba03f15e
2 changed files with 40 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
material/plugins/tags/plugin.py
View File

@ -18,10 +18,15 @@
# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS # FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
# IN THE SOFTWARE. # IN THE SOFTWARE.
import logging
import sys
from collections import defaultdict from collections import defaultdict
from markdown.extensions.toc import slugify from markdown.extensions.toc import slugify
from mkdocs import utils from mkdocs import utils
from mkdocs.commands.build import DuplicateFilter
from mkdocs.config.config_options import Type from mkdocs.config.config_options import Type
from mkdocs.exceptions import ConfigurationError
from mkdocs.plugins import BasePlugin from mkdocs.plugins import BasePlugin
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
@ -59,6 +64,11 @@ class TagsPlugin(BasePlugin):
file = self.config.get("tags_file") file = self.config.get("tags_file")
if file: if file:
self.tags_file = files.get_file_from_path(file) self.tags_file = files.get_file_from_path(file)
if not self.tags_file:
log.error(f"Configuration error: {file} doesn't exist.")
sys.exit()
# Add tags file to files
files.append(self.tags_file) files.append(self.tags_file)
# Build and render tags index page # Build and render tags index page
@ -93,7 +103,7 @@ class TagsPlugin(BasePlugin):
# Render the given tag and links to all pages with occurrences # Render the given tag and links to all pages with occurrences
def __render_tag_links(self, tag, pages): def __render_tag_links(self, tag, pages):
content = ["## <span class=\"md-tag\">{}</span>".format(tag), ""] content = [f"## <span class=\"md-tag\">{tag}</span>", ""]
for page in pages: for page in pages:
url = utils.get_relative_url( url = utils.get_relative_url(
page.file.src_path, page.file.src_path,
@ -113,5 +123,13 @@ class TagsPlugin(BasePlugin):
return dict(name = tag) return dict(name = tag)
else: else:
url = self.tags_file.url url = self.tags_file.url
url += "#{}".format(self.slugify(tag)) url += f"#{self.slugify(tag)}"
return dict(name = tag, url = url) return dict(name = tag, url = url)
# -----------------------------------------------------------------------------
# Data
# -----------------------------------------------------------------------------
# Set up logging
log = logging.getLogger("mkdocs")
log.addFilter(DuplicateFilter())

22
src/plugins/tags/plugin.py
View File

@ -18,10 +18,15 @@
# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS # FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
# IN THE SOFTWARE. # IN THE SOFTWARE.
import logging
import sys
from collections import defaultdict from collections import defaultdict
from markdown.extensions.toc import slugify from markdown.extensions.toc import slugify
from mkdocs import utils from mkdocs import utils
from mkdocs.commands.build import DuplicateFilter
from mkdocs.config.config_options import Type from mkdocs.config.config_options import Type
from mkdocs.exceptions import ConfigurationError
from mkdocs.plugins import BasePlugin from mkdocs.plugins import BasePlugin
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
@ -59,6 +64,11 @@ class TagsPlugin(BasePlugin):
file = self.config.get("tags_file") file = self.config.get("tags_file")
if file: if file:
self.tags_file = files.get_file_from_path(file) self.tags_file = files.get_file_from_path(file)
if not self.tags_file:
log.error(f"Configuration error: {file} doesn't exist.")
sys.exit()
# Add tags file to files
files.append(self.tags_file) files.append(self.tags_file)
# Build and render tags index page # Build and render tags index page
@ -93,7 +103,7 @@ class TagsPlugin(BasePlugin):
# Render the given tag and links to all pages with occurrences # Render the given tag and links to all pages with occurrences
def __render_tag_links(self, tag, pages): def __render_tag_links(self, tag, pages):
content = ["## <span class=\"md-tag\">{}</span>".format(tag), ""] content = [f"## <span class=\"md-tag\">{tag}</span>", ""]
for page in pages: for page in pages:
url = utils.get_relative_url( url = utils.get_relative_url(
page.file.src_path, page.file.src_path,
@ -113,5 +123,13 @@ class TagsPlugin(BasePlugin):
return dict(name = tag) return dict(name = tag)
else: else:
url = self.tags_file.url url = self.tags_file.url
url += "#{}".format(self.slugify(tag)) url += f"#{self.slugify(tag)}"
return dict(name = tag, url = url) return dict(name = tag, url = url)
# -----------------------------------------------------------------------------
# Data
# -----------------------------------------------------------------------------
# Set up logging
log = logging.getLogger("mkdocs")
log.addFilter(DuplicateFilter())