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

spellcheck without building html leads to Unknown directive type: ... #225

Open
goekce opened this issue May 14, 2024 · 0 comments
Open

Comments

@goekce
Copy link

goekce commented May 14, 2024

To recreate:

cd $(mktemp -d)
virtualenv venv
. ./venv/bin/activate
pip install myst-parser sphinx_book_theme git+https://github.com/sphinx-contrib/spelling
sphinx-quickstart
rm index.rst

Then edit conf.py as follows:

project = 'p'
copyright = '2024, a'
author = 'a'
extensions = [
    "myst_parser",
    "sphinxcontrib.spelling",
        ]
templates_path = ['_templates']
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', 'venv']

html_theme = 'sphinx_book_theme'
html_static_path = ['_static']

source_suffix = {
    ".md": "markdown",
}

Create index.md as follows:

```{margin}
test
```

Note that margin is a valid directive in sphinx_book_theme.

Then spellcheck without building html:

sphinx-build -b spelling . _build

Leads to:

...
index.md:1: WARNING: Unknown directive type: 'margin' [myst.directive_unknown]
...

If I build html first, then I get no warning related to this directive. Can someone reproduce this issue?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant