Skip to content

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
madTeddy committed Apr 22, 2019
0 parents commit 605746d
Show file tree
Hide file tree
Showing 11 changed files with 1,312 additions and 0 deletions.
130 changes: 130 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,130 @@

# Created by https://www.gitignore.io/api/python
# Edit at https://www.gitignore.io/?templates=python

### Python ###
# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]
*$py.class

# C extensions
*.so

# Distribution / packaging
.Python
build/
develop-eggs/
dist/
downloads/
eggs/
.eggs/
lib/
lib64/
parts/
sdist/
var/
wheels/
pip-wheel-metadata/
share/python-wheels/
*.egg-info/
.installed.cfg
*.egg
MANIFEST

# PyInstaller
# Usually these files are written by a python script from a template
# before PyInstaller builds the exe, so as to inject date/other infos into it.
*.manifest
*.spec

# Installer logs
pip-log.txt
pip-delete-this-directory.txt

# Unit test / coverage reports
htmlcov/
.tox/
.nox/
.coverage
.coverage.*
.cache
nosetests.xml
coverage.xml
*.cover
.hypothesis/
.pytest_cache/

# Translations
*.mo
*.pot

# Django stuff:
*.log
local_settings.py
db.sqlite3

# Flask stuff:
instance/
.webassets-cache

# Scrapy stuff:
.scrapy

# Sphinx documentation
docs/_build/

# PyBuilder
target/

# Jupyter Notebook
.ipynb_checkpoints

# IPython
profile_default/
ipython_config.py

# pyenv
.python-version

# pipenv
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
# However, in case of collaboration, if having platform-specific dependencies or dependencies
# having no cross-platform support, pipenv may install dependencies that don’t work, or not
# install all needed dependencies.
#Pipfile.lock

# celery beat schedule file
celerybeat-schedule

# SageMath parsed files
*.sage.py

# Environments
.env
.venv
env/
venv/
ENV/
env.bak/
venv.bak/

# Spyder project settings
.spyderproject
.spyproject

# Rope project settings
.ropeproject

# mkdocs documentation
/site

# mypy
.mypy_cache/
.dmypy.json
dmypy.json

# Pyre type checker
.pyre/

# End of https://www.gitignore.io/api/python
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2019 MadTeddy

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
2 changes: 2 additions & 0 deletions MANIFEST.in
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
recursive-include sphinxsharp-pro/locales *
recursive-include sphinxsharp-pro/_static *
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Sphinxsharp Pro
[![Documentation Status](https://readthedocs.org/projects/sphinxsharp-docs/badge/?version=latest)](https://sphinxsharp-docs.readthedocs.io/en/latest/?badge=latest)

CSharp (C#) domain for Sphinx

> This version with custom styling. If you want default styling, then you need [sphinxsharp](https://github.com/madTeddy/sphinxsharp).
## Installing
Install the extension using **pip**:
```
pip install sphinxsharp-pro
```
## Usage
To enable the extension, you need to add the following to your **conf.py**:
```python
extensions = ['sphinxsharp-pro.sphinxsharp']
```
See [the documentation](https://sphinxsharp-docs.readthedocs.io/en/latest/) of using this.
27 changes: 27 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
.. image:: https://readthedocs.org/projects/sphinxsharp-docs/badge/?version=latest
:target: https://sphinxsharp-docs.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status

CSharp (C#) domain for Sphinx

.. hint:: This version with custom styling. If you want default styling, then you need `sphinxsharp <https://github.com/madTeddy/sphinxsharp>`_.

Installing
----------

Install the extension using **pip**:

.. code-block:: python
pip install sphinxsharp-pro
Usage
-----

To enable the extension, you need to add the following to your **conf.py**:

.. code-block:: python
extensions = ['sphinxsharp-pro.sphinxsharp']
See `the documentation <https://sphinxsharp-docs.readthedocs.io/en/latest/>`_ of using this.
2 changes: 2 additions & 0 deletions setup.cfg
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
[metadata]
description-file = README.md
37 changes: 37 additions & 0 deletions setup.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
from setuptools import setup
from os import path
from glob import glob

this_directory = path.abspath(path.dirname(__file__))
with open(path.join(this_directory, 'README.rst'), encoding='utf-8') as f:
long_description = f.read()

setup(
name = 'sphinxsharp-pro',
packages = ['sphinxsharp-pro'],
include_package_data=True,
version = '1.0.0',
license='MIT',
description = 'CSharp (C#) domain for sphinx.',
long_description=long_description,
author = 'Andrey Mignevich',
author_email = '[email protected]',
url = 'https://github.com/madTeddy/sphinxsharp-pro',
download_url = 'https://github.com/madTeddy/sphinxsharp-pro/archive/v1.0.0.tar.gz',
keywords = ['Sphinx','Domain','CSharp','C#','Sphinxsharp','Sphinxsharp Pro'],
install_requires=[
'docutils',
'sphinx',
],
classifiers=[
'Development Status :: 5 - Production/Stable',
'Intended Audience :: Developers',
'Topic :: Software Development :: Build Tools',
'License :: OSI Approved :: MIT License',
'Programming Language :: Python :: 3',
'Programming Language :: Python :: 3.4',
'Programming Language :: Python :: 3.5',
'Programming Language :: Python :: 3.6',
'Programming Language :: Python :: 3.7'
],
)
1 change: 1 addition & 0 deletions sphinxsharp-pro/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
__import__('pkg_resources').declare_namespace(__name__)
96 changes: 96 additions & 0 deletions sphinxsharp-pro/_static/css/sphinxsharp.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,96 @@
dl.csharp > dt {
border-radius: 10px;
border: none !important;
padding: 10px !important;
}
dl.csharp > dd p:not([class]) {
font-size: 14px;
color: rgb(80, 80, 80);
margin: 5px 0px 7px 10px !important;
}
dl.csharp > dd div p {
font-size: 16px !important;
}
dl.csharp .docutils.field-list tr.field > th, td {
padding: 3px 5px 0px 0px !important;
}

.csharp .desc > .first {
font-size: 14px;
margin-right: 18px;
color: #404040;
}
.csharp .desc > .last {
font-size: 13.5px;
}

.csharp .mod {
font-weight: bold;
color: #404040;
}

.csharp.method .desc > .first, .csharp.enum .desc:not(:first-of-type) > .first {
background-color: #e7f2fa;
padding: 4px;
border-radius: 5px;
margin-right: 10px;
}
.csharp.method .desc > .last, .csharp.enum .desc > .last {
font-weight: bold;
}
.csharp.method .desc, .csharp.enum .desc {
margin-bottom: 5px;
}

.csharp .unknown {
color: #2980B9;
}

.csharp .class {
font-weight: bold;
color: #2980B9;
}

.csharp .struct {
font-weight: bold;
color: #0a99f8;
}

.csharp .interface {
font-weight: bold;
color: #2980B9;
}

.csharp .enum {
font-weight: bold;
color: cornflowerblue;
}

.csharp .text {
color: #404040;
}

.csharp .kw {
color: #404040;
font-weight: bold;
}

.csharp .meth-name {
color: #404040;
}

.csharp .delegate {
color: #404040;
}

.csharp .var-name {
color: #404040;
}

.csharp .generic {
color: #2980B9;
}

.csharp .reference.internal:visited{
color: unset !important;
}
Loading

0 comments on commit 605746d

Please sign in to comment.