Skip to content

Commit

Permalink
docs: adopt a new theme: shibuya (#3754)
Browse files Browse the repository at this point in the history
  • Loading branch information
BoboTiG authored Feb 12, 2024
1 parent 261e3d9 commit a2eb60c
Show file tree
Hide file tree
Showing 29 changed files with 286 additions and 707 deletions.
13 changes: 5 additions & 8 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -1,23 +1,20 @@
# File: .readthedocs.yaml

version: 2

# Set the version of Python and other tools you might need
build:
# TODO: update to `latest` once supported
# https://github.com/readthedocs/readthedocs.org/issues/8861
os: ubuntu-22.04
tools:
python: "3.10"
python: "3.11"

# Build from the docs/ directory with Sphinx
sphinx:
configuration: docs/conf.py

formats: all

# We can't use "all" because "htmlzip" format is broken for now
formats:
- epub
- pdf

# Optionally declare the Python requirements required to build your docs
python:
install:
- requirements: requirements-docs.txt
2 changes: 1 addition & 1 deletion Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ ARG VCS_REF
LABEL org.label-schema.build-date=$BUILD_DATE \
org.label-schema.name="Vyper" \
org.label-schema.description="Vyper is an experimental programming language" \
org.label-schema.url="https://vyper.readthedocs.io/en/latest/" \
org.label-schema.url="https://docs.vyperlang.org/en/latest/" \
org.label-schema.vcs-ref=$VCS_REF \
org.label-schema.vcs-url="https://github.com/vyperlang/vyper" \
org.label-schema.vendor="Vyper Team" \
Expand Down
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<img src="https://raw.githubusercontent.com/vyperlang/vyper/master/logo/vyper-logo-transparent.svg?sanitize=true" alt="" width="110">

[![Build Status](https://github.com/vyperlang/vyper/workflows/Test/badge.svg)](https://github.com/vyperlang/vyper/actions/workflows/test.yml)
[![Documentation Status](https://readthedocs.org/projects/vyper/badge/?version=latest)](http://vyper.readthedocs.io/en/latest/?badge=latest "ReadTheDocs")
[![Documentation Status](https://readthedocs.org/projects/vyper/badge/?version=latest)](http://docs.vyperlang.org/en/latest/?badge=latest "ReadTheDocs")
[![Discord](https://img.shields.io/discord/969926564286459934.svg?label=%23vyper)](https://discord.gg/6tw7PTM7C2)

[![PyPI](https://badge.fury.io/py/vyper.svg)](https://pypi.org/project/vyper "PyPI")
Expand All @@ -13,17 +13,17 @@
[![Language grade: Python](https://github.com/vyperlang/vyper/workflows/CodeQL/badge.svg)](https://github.com/vyperlang/vyper/actions/workflows/codeql.yml)

# Getting Started
See [Installing Vyper](http://vyper.readthedocs.io/en/latest/installing-vyper.html) to install vyper.
See [Installing Vyper](http://docs.vyperlang.org/en/latest/installing-vyper.html) to install vyper.
See [Tools and Resources](https://github.com/vyperlang/vyper/wiki/Vyper-tools-and-resources) for an additional list of framework and tools with vyper support.
See [Documentation](http://vyper.readthedocs.io/en/latest/index.html) for the documentation and overall design goals of the Vyper language.
See [Documentation](http://docs.vyperlang.org/en/latest/index.html) for the documentation and overall design goals of the Vyper language.

See [Learn.Vyperlang.org](https://learn.vyperlang.org/) for **learning Vyper by building a Pokémon game**.
See [try.vyperlang.org](https://try.vyperlang.org/) to use Vyper in a hosted jupyter environment!

**Note: Vyper is beta software, use with care**

# Installation
See the [Vyper documentation](https://vyper.readthedocs.io/en/latest/installing-vyper.html)
See the [Vyper documentation](https://docs.vyperlang.org/en/latest/installing-vyper.html)
for build instructions.

# Compiling a contract
Expand All @@ -47,7 +47,7 @@ be a bit behind the latest version found in the master branch of this repository

## Testing (using pytest)

(Complete [installation steps](https://vyper.readthedocs.io/en/latest/installing-vyper.html) first.)
(Complete [installation steps](https://docs.vyperlang.org/en/latest/installing-vyper.html) first.)

```bash
make dev-init
Expand Down Expand Up @@ -75,4 +75,4 @@ To get a call graph from a python profile, https://stackoverflow.com/a/23164271/
* See Issues tab, and feel free to submit your own issues
* Add PRs if you discover a solution to an existing issue
* For further discussions and questions, post in [Discussions](https://github.com/vyperlang/vyper/discussions) or talk to us on [Discord](https://discord.gg/6tw7PTM7C2)
* For more information, see [Contributing](http://vyper.readthedocs.io/en/latest/contributing.html)
* For more information, see [Contributing](http://docs.vyperlang.org/en/latest/contributing.html)
215 changes: 0 additions & 215 deletions docs/_static/css/dark.css

This file was deleted.

77 changes: 0 additions & 77 deletions docs/_static/css/toggle.css

This file was deleted.

Loading

0 comments on commit a2eb60c

Please sign in to comment.