Skip to content

Commit

Permalink
Add a complete example.
Browse files Browse the repository at this point in the history
  • Loading branch information
domdfcoding committed Jun 28, 2021
1 parent f83b6cd commit 61c8b01
Show file tree
Hide file tree
Showing 8 changed files with 135 additions and 0 deletions.
34 changes: 34 additions & 0 deletions doc-source/_static/fonts/LICENSE.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
Font Awesome Free License
-------------------------

Font Awesome Free is free, open source, and GPL friendly. You can use it for
commercial projects, open source projects, or really almost whatever you want.
Full Font Awesome Free license: https://fontawesome.com/license/free.

# Icons: CC BY 4.0 License (https://creativecommons.org/licenses/by/4.0/)
In the Font Awesome Free download, the CC BY 4.0 license applies to all icons
packaged as SVG and JS file types.

# Fonts: SIL OFL 1.1 License (https://scripts.sil.org/OFL)
In the Font Awesome Free download, the SIL OFL license applies to all icons
packaged as web and desktop font files.

# Code: MIT License (https://opensource.org/licenses/MIT)
In the Font Awesome Free download, the MIT license applies to all non-font and
non-icon files.

# Attribution
Attribution is required by MIT, SIL OFL, and CC BY licenses. Downloaded Font
Awesome Free files already contain embedded comments with sufficient
attribution, so you shouldn't need to do anything additional when using these
files normally.

We've kept attribution comments terse, so we ask that you do not actively work
to remove them from files, especially code. They're a great way for folks to
learn about Font Awesome.

# Brand Icons
All brand icons are trademarks of their respective owners. The use of these
trademarks does not indicate endorsement of the trademark holder by Font
Awesome, nor vice versa. **Please do not use brand logos for any purpose except
to represent the company, product, or service to which they refer.**
Binary file added doc-source/_static/fonts/fontawesome-webfont.ttf
Binary file not shown.
Binary file added doc-source/_static/fonts/fontawesome-webfont.woff
Binary file not shown.
Binary file not shown.
27 changes: 27 additions & 0 deletions doc-source/_static/style.css
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,30 @@ div.highlight {
.field-list dt, dl.simple dt {
margin-top: 0.5rem;
}

div.versionchanged ul, div.versionremoved ul {
margin-left: 20px;
margin-top: 0;
}


/* Font Awesome 4.7.0 by @davegandy - http://fontawesome.io - @fontawesome
* License - http://fontawesome.io/license (Font: SIL OFL 1.1, CSS: MIT License)
*/
@font-face {
font-family: 'FontAwesome';
src: url("./fonts/fontawesome-webfont.woff2?v=4.7.0") format("woff2"),
url("./fonts/fontawesome-webfont.woff?v=4.7.0") format("woff"),
url("./fonts/fontawesome-webfont.ttf?v=4.7.0") format("truetype");
font-weight: normal;
font-style: normal
}

.download code.download span:first-child:before {
content: "";
display: inline-block;
font: normal normal normal 14px/1 FontAwesome;
margin-right: .3em;
margin-left: .3em;
text-decoration: inherit;
}
15 changes: 15 additions & 0 deletions doc-source/configuration.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _configuration:

=====================
Configuration
=====================
Expand Down Expand Up @@ -594,3 +596,16 @@ As a minimum, the table MUST contain the keys :conf:`name` and :conf:`version` [
"3.6",
"3.7",
]
Complete Example
------------------

This is an example of a complete ``pyproject.toml`` file for :pep:`621`.

For an explanation of each field, see the :ref:`configuration` section.


.. literalinclude:: pyproject.toml
:caption: :download:`pyproject.toml`
:language: toml
58 changes: 58 additions & 0 deletions doc-source/pyproject.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
[build-system]
requires = [ "whey",]
build-backend = "whey"

[project]
name = "spam"
version = "2020.0.0"
description = "Lovely Spam! Wonderful Spam!"
readme = "README.rst"
requires-python = ">=3.8"
license = {file = "LICENSE.txt"}
keywords = [ "egg", "bacon", "sausage", "tomatoes", "Lobster Thermidor",]
authors = [
{name = "Dominic Davis-Foster", email = "dominic@davis-foster.co.uk"},
{name = "The pip developers", email = "distutils-sig@python.org"}
]
maintainers = [
{name = "Brett Cannon", email = "brett@python.org"}
]
classifiers = [
"Development Status :: 4 - Beta",
"Programming Language :: Python"
]

dependencies = [
"httpx",
"gidgethub[httpx]>4.0.0",
"django>2.1; os_name != 'nt'",
"django>2.0; os_name == 'nt'"
]

[project.optional-dependencies]
test = [
"pytest < 5.0.0",
"pytest-cov[all]"
]

[project.urls]
homepage = "https://example.com"
documentation = "https://readthedocs.org"
repository = "https://github.com"
changelog = "https://github.com/me/spam/blob/master/CHANGELOG.md"

[project.scripts]
spam-cli = "spam:main_cli"
# One which depends on extras:
foobar = "foomod:main_bar [bar,baz]"


[project.gui-scripts]
spam-gui = "spam:main_gui"

[project.entry-points."spam.magical"]
tomatoes = "spam:main_tomatoes"

# pytest plugins refer to a module, so there is no ':obj'
[project.entry-points.pytest11]
nbval = "nbval.plugin"
1 change: 1 addition & 0 deletions repo_helper.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ min_coverage: 90
docs_fail_on_warning: true
sphinx_html_theme: furo
tox_testenv_extras: readme
preserve_custom_theme: true

conda_channels:
- conda-forge
Expand Down

0 comments on commit 61c8b01

Please sign in to comment.