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.

Sign up for GitHub

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

Jump to bottom

Some warnings when building the docs #189

Open
Mariatta opened this issue Jul 16, 2018 · 3 comments · May be fixed by #201
Open

Some warnings when building the docs #189

Mariatta opened this issue Jul 16, 2018 · 3 comments · May be fixed by #201

Comments

@Mariatta
Copy link
Contributor

There were some warnings when I built the docs using Sphinx 1.7.4.
Any interest in cleaning these up?
I can also try add building the documenation as part of travis job.

make html

...                                                                                                                                                                              
/Users/mariatta/github/flit/doc/pyproject_toml.rst:21: WARNING: Pygments lexer name 'toml' is not known
/Users/mariatta/github/flit/doc/pyproject_toml.rst:42: WARNING: Pygments lexer name 'toml' is not known
/Users/mariatta/github/flit/doc/pyproject_toml.rst:64: WARNING: Pygments lexer name 'toml' is not known
/Users/mariatta/github/flit/doc/pyproject_toml.rst:101: WARNING: Pygments lexer name 'toml' is not known
/Users/mariatta/github/flit/doc/pyproject_toml.rst:133: WARNING: Pygments lexer name 'toml' is not known
/Users/mariatta/github/flit/doc/pyproject_toml.rst:150: WARNING: Pygments lexer name 'toml' is not known
/Users/mariatta/github/flit/doc/pyproject_toml.rst:166: WARNING: Pygments lexer name 'toml' is not known
/Users/mariatta/github/flit/doc/upload.rst:60: WARNING: unknown option: --repository

...

The HTML pages are in _build/html.
@takluyver
Copy link
Member

The proper way to fix this is to make a toml lexer available. There isn't one built into pygments, but one has been written - maybe it just needs to be packaged up as a pygments plugin. https://bitbucket.org/birkenfeld/pygments-main/issues/1150/new-lexer-request-toml-rust

@takluyver
Copy link
Member

Mostly fixed in #181 by adding a dependency on github-pygments-lexers.

The --repository option is still acting up. I don't know if there's a way to point Sphinx to a qualified option, i.e. say that it's a reference to --repository on flit publish. 😕

@Mariatta
Copy link
Contributor Author

It looks like, according this doc, the markup should be:

:option:`flit --repository`

I can create a PR with this change.

Mariatta added a commit to Mariatta/flit that referenced this issue Aug 28, 2018
@Mariatta
Fix warnings when building the documentation.
ce19e7d 
Fix the warning related to `--repository` option.
Add sphinx to requirements-test.
Run `make html` as part of travis CI.

Closes pypa#189
@Mariatta Mariatta linked a pull request Aug 28, 2018 that will close this issue
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Fix warnings when building the documentation. Mariatta/flit
2 participants
@takluyver @Mariatta