osteele / flinx

Configuration-free Sphinx documentation
MIT License
5 stars 2 forks source link

fix plaintext pypi docs #5

Closed graingert closed 4 years ago

graingert commented 4 years ago
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 commented 4 years ago

Thank you for your contribution