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

fix plaintext pypi docs #5

Merged
merged 1 commit into from Nov 7, 2020

Conversation

graingert
Copy link
Contributor

The file description seems not to be valid rst for PyPI; it will be interpreted as plain text                                                                                                                                                                      E-flit.validate
<string>:44: (ERROR/3) Unknown directive type "todo".

.. todo:: Currently this pollutes ``./docs``.

                                                                                                                                                             E-flit.validate
Config error: Invalid config values (see log)
Found 31 files tracked in git                                                                                                                                                                                                                                         I-flit.sdist
Traceback (most recent call last):
  File "/home/graingert/.virtualenvs/flit/bin/flit", line 8, in <module>
    sys.exit(main())
  File "/home/graingert/.virtualenvs/flit/lib/python3.8/site-packages/flit/__init__.py", line 170, in main
    main(args.ini_file, formats=set(args.format or []),
  File "/home/graingert/.virtualenvs/flit/lib/python3.8/site-packages/flit/build.py", line 46, in main
    sdist_file = sb.build(dist_dir, gen_setup_py=gen_setup_py)
  File "/home/graingert/.virtualenvs/flit/lib/python3.8/site-packages/flit/sdist.py", line 223, in build
    return Path(super().build(str(target_dir), gen_setup_py=gen_setup_py))
  File "/home/graingert/.virtualenvs/flit/lib/python3.8/site-packages/flit_core/sdist.py", line 181, in build
    files_to_add = self.apply_includes_excludes(self.select_files())
  File "/home/graingert/.virtualenvs/flit/lib/python3.8/site-packages/flit_core/sdist.py", line 154, in apply_includes_excludes
    raise Exception("Crucial files were excluded from the sdist: {}"
Exception: Crucial files were excluded from the sdist: ./readme.rst

```
The file description seems not to be valid rst for PyPI; it will be interpreted as plain text                                                                                                                                                                      E-flit.validate
<string>:44: (ERROR/3) Unknown directive type "todo".

.. todo:: Currently this pollutes ``./docs``.

                                                                                                                                                             E-flit.validate
Config error: Invalid config values (see log)
```

```
Found 31 files tracked in git                                                                                                                                                                                                                                         I-flit.sdist
Traceback (most recent call last):
  File "/home/graingert/.virtualenvs/flit/bin/flit", line 8, in <module>
    sys.exit(main())
  File "/home/graingert/.virtualenvs/flit/lib/python3.8/site-packages/flit/__init__.py", line 170, in main
    main(args.ini_file, formats=set(args.format or []),
  File "/home/graingert/.virtualenvs/flit/lib/python3.8/site-packages/flit/build.py", line 46, in main
    sdist_file = sb.build(dist_dir, gen_setup_py=gen_setup_py)
  File "/home/graingert/.virtualenvs/flit/lib/python3.8/site-packages/flit/sdist.py", line 223, in build
    return Path(super().build(str(target_dir), gen_setup_py=gen_setup_py))
  File "/home/graingert/.virtualenvs/flit/lib/python3.8/site-packages/flit_core/sdist.py", line 181, in build
    files_to_add = self.apply_includes_excludes(self.select_files())
  File "/home/graingert/.virtualenvs/flit/lib/python3.8/site-packages/flit_core/sdist.py", line 154, in apply_includes_excludes
    raise Exception("Crucial files were excluded from the sdist: {}"
Exception: Crucial files were excluded from the sdist: ./readme.rst
```
@osteele osteele merged commit a312ad5 into osteele:master Nov 7, 2020
@osteele
Copy link
Owner

osteele commented Nov 7, 2020

Thank you for your contribution

@graingert graingert deleted the fix-plaintext-pypi-docs branch November 7, 2020 07:02
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

Successfully merging this pull request may close these issues.

None yet

2 participants