diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 00000000000..a99ea84dd3b --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,13 @@ +name: "CI" +on: +- pull_request +- push + +jobs: + docs: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + - uses: ammaraskar/sphinx-action@0.4 + with: + docs-folder: "." \ No newline at end of file diff --git a/.gitignore b/.gitignore index 9570afcfdc8..db15bb41c2c 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,3 @@ build/ -lib/ -include/ + diff --git a/.readthedocs.yml b/.readthedocs.yml new file mode 100644 index 00000000000..6a9460d3819 --- /dev/null +++ b/.readthedocs.yml @@ -0,0 +1,20 @@ +# .readthedocs.yml +# Read the Docs configuration file +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + +# Required +version: 2 + +sphinx: + configuration: source/conf.py + fail_on_warning: true + + +# Optionally build your docs in additional formats such as PDF and ePub +formats: all + +# Optionally set the version of Python and requirements required to build your docs +python: + version: 3 + install: + - requirements: requirements.txt diff --git a/.travis.yml b/.travis.yml deleted file mode 100644 index 1ddfe049c94..00000000000 --- a/.travis.yml +++ /dev/null @@ -1,6 +0,0 @@ -language: python -install: - - pip install -e . -script: - - make html - - make linkcheck diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 00000000000..bc5b3668a87 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,2 @@ +sphinx==3.0.3 +Pallets-Sphinx-Themes==1.2.3 diff --git a/setup.py b/setup.py deleted file mode 100644 index d0da8d442ef..00000000000 --- a/setup.py +++ /dev/null @@ -1,39 +0,0 @@ -# -*- coding: utf-8 -*- - -import os - -from setuptools import setup -from setuptools import find_packages - - -def read(rnames): - name = os.path.join(os.path.dirname(__file__), rnames) - with open(name, 'r') as f: - return f.read() - -install_requires = [ "Sphinx", "sphinx_rtd_theme" ] - -setup(name='nix-cookbook', - version_format='{tag}.{commitcount}+{gitsha}', - description='', - long_description=read('README.rst'), - classifiers=[ - "Programming Language :: Python", - "Programming Language :: Python :: Implementation :: CPython", - "Programming Language :: Python :: Implementation :: PyPy", - "Programming Language :: Python :: 3.4", - "Programming Language :: Python :: 3.5", - ], - author='Domen Kozar', - license='BSD', - packages=find_packages(), - install_requires=install_requires, - setup_requires=[ - 'setuptools-git >= 0', - 'setuptools-git-version', - ], - entry_points=""" - """, - include_package_data=True, - zip_safe=False, - ) diff --git a/source/conf.py b/source/conf.py index 04394fde4af..0a62cd1de6a 100644 --- a/source/conf.py +++ b/source/conf.py @@ -32,6 +32,7 @@ extensions = [ 'sphinx.ext.intersphinx', 'sphinx.ext.todo', + 'pallets_sphinx_themes', ] # Add any paths that contain templates here, relative to this directory. @@ -49,7 +50,7 @@ master_doc = 'index' # General information about the project. -project = 'nix-cookbook' +project = 'nix.dev' copyright = u'2016, Domen Kožar' author = u'Domen Kožar' @@ -113,13 +114,7 @@ # -- Options for HTML output ---------------------------------------------- -# The theme to use for HTML and HTML Help pages. See the documentation for -# a list of builtin themes. -import sphinx_rtd_theme - -html_theme = "sphinx_rtd_theme" - -html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] +html_theme = "flask" # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the @@ -213,7 +208,7 @@ #html_search_scorer = 'scorer.js' # Output file base name for HTML help builder. -htmlhelp_basename = 'nixpkgs-cookbookdoc' +#htmlhelp_basename = 'nixpkgs-' # -- Options for LaTeX output ---------------------------------------------