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

Warnings when building the docs #9150

Open
bbatsov opened this issue Dec 2, 2020 · 3 comments
Open

Warnings when building the docs #9150

bbatsov opened this issue Dec 2, 2020 · 3 comments
Labels
documentation good first issue Easy task, suitable for newcomers to the project maintenance

Comments

@bbatsov
Copy link
Collaborator

bbatsov commented Dec 2, 2020

There are some annoying warnings when building the documentation site:

$ antora --pull antora-playbook.yml
asciidoctor: WARNING: skipping reference to missing attribute: 1
asciidoctor: WARNING: skipping reference to missing attribute: 3
asciidoctor: WARNING: skipping reference to missing attribute: word
asciidoctor: WARNING: skipping reference to missing attribute: word
asciidoctor: WARNING: skipping reference to missing attribute: word
asciidoctor: WARNING: skipping reference to missing attribute: foo
asciidoctor: WARNING: skipping reference to missing attribute: foo
asciidoctor: WARNING: skipping reference to missing attribute: foo

I think I had hunted them down in the past, but I no longer remember where exactly those were (they are definitely in the auto-generated cop documentation for the main gem). Still, we should fix them eventually.

@bbatsov
Copy link
Collaborator Author

bbatsov commented Mar 2, 2021

I've tracked down the warnings to this spring-projects/spring-restdocs#527

Basically we can't have something like {foo} or {Word} in the AsciiDoc markup. This has to be escaped like +{foo}+.

@bbatsov bbatsov added the good first issue Easy task, suitable for newcomers to the project label Mar 2, 2021
@wcmonty
Copy link

wcmonty commented Jul 2, 2021

I believe we need to escape {foo} with \{foo\} instead of +{foo}+.

@HeroProtagonist
Copy link
Contributor

Happy Hacktoberfest 🎃

I opened rubocop/docs.rubocop.org#3 which will remove these warnings.

It looks like there are lots of errors getting printed in addition to the ones that will be removed via the PR.
I could take a look into those as well if wanted. Might also be a configuration setting.

asciidoctor: ERROR: cops_lint.adoc: line 604: level 0 sections can only be used when doctype is book
asciidoctor: ERROR: cops_lint.adoc: line 606: level 0 sections can only be used when doctype is book
asciidoctor: ERROR: cops_lint.adoc: line 615: level 0 sections can only be used when doctype is book
...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation good first issue Easy task, suitable for newcomers to the project maintenance
Projects
None yet
3 participants