Skip to content

Commit

Permalink
Fix footnote
Browse files Browse the repository at this point in the history
  • Loading branch information
Michaelvll committed Aug 5, 2022
1 parent 16de833 commit d45638a
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 9 deletions.
12 changes: 4 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@
![pytest](https://github.com/skypilot-org/skypilot/actions/workflows/pytest.yml/badge.svg)
[![Documentation Status](https://readthedocs.org/projects/skypilot/badge/?version=latest)](https://skypilot.readthedocs.io/en/latest/?badge=latest)

SkyPilot is a framework for easily running machine learning<sup id="r1">[\[1\]](#footnote1)</sup> workloads on any cloud through a unified interface. No knowledge of cloud offerings is required or expected – you simply define the workload and its resource requirements, and SkyPilot will automatically execute it on AWS, Google Cloud Platform or Microsoft Azure.
SkyPilot is a framework for easily running machine learning[^1] workloads on any cloud through a unified interface. No knowledge of cloud offerings is required or expected – you simply define the workload and its resource requirements, and SkyPilot will automatically execute it on AWS, Google Cloud Platform or Microsoft Azure.


### Key features
* **Run existing projects on the cloud** with zero code changes
Expand Down Expand Up @@ -74,10 +75,5 @@ We are excited to hear your feedback! SkyPilot has two channels for engaging wit
## Contributing
We welcome and value all contributions to the project! Please refer to the [contribution guide](CONTRIBUTING.md) for more on how to get involved.

<section data-footnotes="" class="footnotes">
<ol dir="auto">
<li id="footnote1">
<p dir="auto">SkyPilot is primarily targeted at machine learning workloads, but it can also support many general workloads. We're excited to hear about your use case and would love to hear more about how we can better support your requirements - please join us in <a href="https://github.com/skypilot-org/skypilot/discussions/1016" data-hovercard-type="discussion" data-hovercard-url="/skypilot-org/skypilot/discussions/1016/hovercard">this discussion</a>! <a href="#user-content-fnref-1-ef971f73800a6dd5adf6bd5da0078476" data-footnote-backref="" aria-label="Back to content" class="data-footnote-backref"><g-emoji class="g-emoji" alias="leftwards_arrow_with_hook" fallback-src="https://github.githubassets.com/images/icons/emoji/unicode/21a9.png">↩</g-emoji></a></p>
</li>
</ol>
</section>

[^1]: SkyPilot is primarily targeted at machine learning workloads, but it can also support many general workloads. We're excited to hear about your use case and would love to hear more about how we can better support your requirements - please join us in [this discussion](https://github.com/skypilot-org/skypilot/discussions/1016)!
9 changes: 8 additions & 1 deletion sky/setup_files/setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
you simply define the workload and its resource requirements, and SkyPilot will
automatically execute it on AWS, Google Cloud Platform or Microsoft Azure.
*: [^1]: SkyPilot is primarily targeted at machine learning workloads, but it can also
*: SkyPilot is primarily targeted at machine learning workloads, but it can also
support many general workloads. We're excited to hear about your use case and would
love to hear more about how we can better support your requirements - please join us
in [this discussion](https://github.com/skypilot-org/skypilot/discussions/1016)
Expand Down Expand Up @@ -43,6 +43,11 @@ def find_version(*filepath):
return version_match.group(1)
raise RuntimeError('Unable to find version string.')

def parse_footnote(readme: str) -> str:
"""Parse the footnote from the README.md file."""
footnote_re = re.compile(r'\[\^([0-9]+)\]')
return footnote_re.sub(r'<sup>[\1]</sup>', readme)


install_requires = [
'wheel',
Expand Down Expand Up @@ -92,6 +97,8 @@ def find_version(*filepath):
# Skip the description for that case.
if os.path.exists(readme_filepath):
long_description = io.open(readme_filepath, 'r', encoding='utf-8').read()
long_description = parse_footnote(long_description)


setuptools.setup(
# NOTE: this affects the package.whl wheel name. When changing this (if
Expand Down

0 comments on commit d45638a

Please sign in to comment.