**************************
Readme
**************************
this is a rtl theme for Sphinx_.
i use `Read the Docs`_ as a base.
.. _Sphinx: http://www.sphinx-doc.org
.. _Read the Docs: http://www.readthedocs.org
Installation
================================
This theme is distributed on PyPI_ and can be installed with ``pip``:
.. code:: console
$ pip install ashk-sphinx-theme
To use the theme in your Sphinx project, you will need to edit
your ``conf.py`` file's ``html_theme`` setting:
.. code:: python
html_theme = "sphinx_rtd_theme"
.. _PyPI: https://pypi.python.org/pypi/sphinx_rtd_theme
Development:
================================
for development first read `configuring the theme`_ .
tip: for upgrade and upload to pypi remember to change the version in both files: setup.cfg & setup.py
use python3.10
make a venv:
.. code:: bash
python3.10 -m venv vevn
source venv/bin/activate
pip install -e '.[dev]'
if there was a problem with installation use you may want to use this:
.. code:: bash
npm install webpack webpack-dev-server webpack-cli --save-dev
webpack-dev-server --open --config webpack.dev.js
python -m pip install build twine
.. code:: bash
npm install
npm run build
python setup.py sdist bdist_wheel
.. _configuring the theme: https://sphinx-rtd-theme.readthedocs.io/en/stable/configuring.html
Releasing the theme
================================
for release the theme use:
.. code:: bash
rm -rf dist/
python setup.py sdist bdist_wheel
twine upload -r pypi --verbose dist/*
Raw data
{
"_id": null,
"home_page": "https://github.com/a-ramti/ashk_sphinx_theme",
"name": "ashk-sphinx-theme",
"maintainer": "",
"docs_url": null,
"requires_python": "!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,>=2.7",
"maintainer_email": "",
"keywords": "",
"author": "Dave Snider, Read the Docs, Inc. & contributors",
"author_email": "dev@readthedocs.org",
"download_url": "https://files.pythonhosted.org/packages/97/f6/9f6ff55f07820bb9474b12aaf4ba025c83fe07a4957d15536359c887d3fb/ashk_sphinx_theme-1.1.10.tar.gz",
"platform": null,
"description": "**************************\nReadme\n**************************\nthis is a rtl theme for Sphinx_.\ni use `Read the Docs`_ as a base. \n\n.. _Sphinx: http://www.sphinx-doc.org\n.. _Read the Docs: http://www.readthedocs.org\n\nInstallation\n================================\n\nThis theme is distributed on PyPI_ and can be installed with ``pip``:\n\n.. code:: console\n\n $ pip install ashk-sphinx-theme\n\nTo use the theme in your Sphinx project, you will need to edit\nyour ``conf.py`` file's ``html_theme`` setting:\n\n.. code:: python\n\n html_theme = \"sphinx_rtd_theme\"\n\n\n.. _PyPI: https://pypi.python.org/pypi/sphinx_rtd_theme\n\nDevelopment:\n================================\n\nfor development first read `configuring the theme`_ .\n\ntip: for upgrade and upload to pypi remember to change the version in both files: setup.cfg & setup.py\n\n\n\nuse python3.10\n\nmake a venv:\n\n.. code:: bash\n\n python3.10 -m venv vevn\n source venv/bin/activate\n pip install -e '.[dev]'\n\nif there was a problem with installation use you may want to use this:\n\n.. code:: bash\n\n npm install webpack webpack-dev-server webpack-cli --save-dev\n webpack-dev-server --open --config webpack.dev.js\n python -m pip install build twine\n\n\n.. code:: bash\n\n npm install\n npm run build\n python setup.py sdist bdist_wheel\n\n\n.. _configuring the theme: https://sphinx-rtd-theme.readthedocs.io/en/stable/configuring.html\n\n\nReleasing the theme\n================================\nfor release the theme use:\n\n.. code:: bash\n\n rm -rf dist/\n python setup.py sdist bdist_wheel\n twine upload -r pypi --verbose dist/*\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Read the Docs theme for Sphinx",
"version": "1.1.10",
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c7ddf32f52b8de88bef2c3387c245ebe559a804f2afec10abe34d5540bdd8c49",
"md5": "6b2cc9edb00cbe9d4d3c56eb4a2d4506",
"sha256": "14743284cb97982ac4c99c3db3d8420ae37b1996f2434e9ae284c817c8c9a33e"
},
"downloads": -1,
"filename": "ashk_sphinx_theme-1.1.10-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "6b2cc9edb00cbe9d4d3c56eb4a2d4506",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": "!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,>=2.7",
"size": 3269120,
"upload_time": "2023-01-09T08:50:20",
"upload_time_iso_8601": "2023-01-09T08:50:20.037144Z",
"url": "https://files.pythonhosted.org/packages/c7/dd/f32f52b8de88bef2c3387c245ebe559a804f2afec10abe34d5540bdd8c49/ashk_sphinx_theme-1.1.10-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "97f69f6ff55f07820bb9474b12aaf4ba025c83fe07a4957d15536359c887d3fb",
"md5": "1e72219404a45a24c10d372a24994ca2",
"sha256": "1e02252dce5a2a5870d36dc893b29b54f80787888e21530878afe5c1dc88bb81"
},
"downloads": -1,
"filename": "ashk_sphinx_theme-1.1.10.tar.gz",
"has_sig": false,
"md5_digest": "1e72219404a45a24c10d372a24994ca2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,>=2.7",
"size": 3229226,
"upload_time": "2023-01-09T08:50:26",
"upload_time_iso_8601": "2023-01-09T08:50:26.917847Z",
"url": "https://files.pythonhosted.org/packages/97/f6/9f6ff55f07820bb9474b12aaf4ba025c83fe07a4957d15536359c887d3fb/ashk_sphinx_theme-1.1.10.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-01-09 08:50:26",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "a-ramti",
"github_project": "ashk_sphinx_theme",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"circle": true,
"tox": true,
"lcname": "ashk-sphinx-theme"
}
JSON
