Skip to content

Commit

Permalink
[docs] Removed github stars and forks from docs pages
Browse files Browse the repository at this point in the history
Painful to maintain and causes issues if the domain changes, not worth it.
  • Loading branch information
nemesifier committed Apr 20, 2022
1 parent fbe5b8e commit 7498dea
Show file tree
Hide file tree
Showing 15 changed files with 4 additions and 38 deletions.
6 changes: 0 additions & 6 deletions docs/source/_github.rst

This file was deleted.

10 changes: 4 additions & 6 deletions docs/source/backends/create_your_backend.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,7 @@
Create your backend
===================

.. include:: ../_github.rst

Every backend is based on the common ground of some elements provided by the
Every backend is based on the common ground of some elements provided by the
netjsonconfig library. The ``BaseBackend``, ``BaseConverter``, ``BaseParser`` and
``BaseRenderer`` are a battle proven set of tools that can be extended when
creating you backend.
Expand All @@ -23,7 +21,7 @@ project root directory.
# example_backend/setup.py
from setuptools import setup, find_packages
setup(
name='example_backend',
version='0.0.0',
Expand Down Expand Up @@ -86,9 +84,9 @@ The previous example can be used with the following class definition
from netjsonconfig.backends.base.backend import BaseBackend
from netjsonconfig.backends.base.renderer import BaseRenderer
from netjsonconfig.backends.base.parser import BaseParser
from netjsonconfig.schema import schema as default_schema
class ExampleBackend(BaseBackend):
schema = default_schema
converter = []
Expand Down
2 changes: 0 additions & 2 deletions docs/source/backends/openvpn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@
OpenVPN 2.3 Backend
===================

.. include:: ../_github.rst

The ``OpenVpn`` backend allows to generate OpenVPN 2.3.x compatible configurations.

Its schema is limited to a subset of the features available in OpenVPN and it doesn't recognize
Expand Down
2 changes: 0 additions & 2 deletions docs/source/backends/openwisp.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@
OpenWISP 1.x Backend
====================

.. include:: ../_github.rst

The OpenWISP 1.x Backend is based on the OpenWRT backend, therefore it inherits all
its features with some differences that are explained in this page.

Expand Down
2 changes: 0 additions & 2 deletions docs/source/backends/openwrt.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@
OpenWRT Backend
===============

.. include:: ../_github.rst

The ``OpenWrt`` backend allows to generate OpenWRT compatible configurations.

.. note::
Expand Down
2 changes: 0 additions & 2 deletions docs/source/backends/vpn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@
VPN Backends
============

.. include:: ../_github.rst

``netjsonconfig`` currently supports three VPN backends:

.. toctree::
Expand Down
2 changes: 0 additions & 2 deletions docs/source/backends/vxlan_over_wireguard.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@
VXLAN over WireGuard Backend
============================

.. include:: ../_github.rst

The ``VXLAN over WireGuard`` backend extends :doc:`Wireguard backend </backends/wireguard>`
to add configurations required for configuring VXLAN tunnels encapsulated in
WireGuard tunnels.
Expand Down
2 changes: 0 additions & 2 deletions docs/source/backends/wireguard.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@
WireGuard Backend
=================

.. include:: ../_github.rst

The ``WireGuard`` backend allows to generate WireGuard configurations.

Its schema is limited to a subset of the features available in WireGuard and it doesn't recognize
Expand Down
2 changes: 0 additions & 2 deletions docs/source/general/basics.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@
Basic concepts
==============

.. include:: ../_github.rst

Before starting, let's quickly introduce the main concepts used in netjsonconfig:

* :ref:`configuration_dictionary`: python dictionary representing the configuration of a router
Expand Down
2 changes: 0 additions & 2 deletions docs/source/general/commandline_utility.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@
Command line utility
====================

.. include:: ../_github.rst

netjsonconfig ships a command line utility that can be
used from the interactive shell, bash scripts or other programming
languages.
Expand Down
2 changes: 0 additions & 2 deletions docs/source/general/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@
Contributing
============

.. include:: ../_github.rst

Thank you for taking the time to contribute to netjsonconfig.

Follow these guidelines to speed up the process.
Expand Down
2 changes: 0 additions & 2 deletions docs/source/general/goals.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
Motivations and Goals
=====================

.. include:: ../_github.rst

In this page we explain the goals of this project and the motivations
that led us on this path.

Expand Down
2 changes: 0 additions & 2 deletions docs/source/general/running_tests.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@
Running tests
=============

.. include:: ../_github.rst

Running the test suite is really straightforward!

Using runtests.py
Expand Down
2 changes: 0 additions & 2 deletions docs/source/general/setup.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@
Setup
=====

.. include:: ../_github.rst

Install stable version from pypi
--------------------------------

Expand Down
2 changes: 0 additions & 2 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,6 @@ configuration engine of `OpenWISP 2 <https://github.com/openwisp/ansible-openwis
.. image:: ./images/openwisp.org.svg
:target: http://openwisp.org

.. include:: _github.rst

**netjsonconfig** is a python library that converts `NetJSON <http://netjson.org>`_
*DeviceConfiguration* objects into real router configurations that can be installed
on systems like `OpenWRT <http://openwrt.org>`_, `LEDE <https://www.lede-project.org/>`_
Expand Down

0 comments on commit 7498dea

Please sign in to comment.