mirror of
https://github.com/NixOS/nix.dev.git
synced 2024-10-18 14:32:43 -04:00
commit
2122e9a5f5
13
.github/workflows/ci.yml
vendored
Normal file
13
.github/workflows/ci.yml
vendored
Normal file
|
@ -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: "."
|
3
.gitignore
vendored
3
.gitignore
vendored
|
@ -1,4 +1,3 @@
|
||||||
build/
|
build/
|
||||||
lib/
|
|
||||||
include/
|
|
||||||
|
|
||||||
|
|
20
.readthedocs.yml
Normal file
20
.readthedocs.yml
Normal file
|
@ -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
|
|
@ -1,6 +0,0 @@
|
||||||
language: python
|
|
||||||
install:
|
|
||||||
- pip install -e .
|
|
||||||
script:
|
|
||||||
- make html
|
|
||||||
- make linkcheck
|
|
2
requirements.txt
Normal file
2
requirements.txt
Normal file
|
@ -0,0 +1,2 @@
|
||||||
|
sphinx==3.0.3
|
||||||
|
Pallets-Sphinx-Themes==1.2.3
|
39
setup.py
39
setup.py
|
@ -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,
|
|
||||||
)
|
|
|
@ -32,6 +32,7 @@ import os
|
||||||
extensions = [
|
extensions = [
|
||||||
'sphinx.ext.intersphinx',
|
'sphinx.ext.intersphinx',
|
||||||
'sphinx.ext.todo',
|
'sphinx.ext.todo',
|
||||||
|
'pallets_sphinx_themes',
|
||||||
]
|
]
|
||||||
|
|
||||||
# Add any paths that contain templates here, relative to this directory.
|
# Add any paths that contain templates here, relative to this directory.
|
||||||
|
@ -49,7 +50,7 @@ source_suffix = '.rst'
|
||||||
master_doc = 'index'
|
master_doc = 'index'
|
||||||
|
|
||||||
# General information about the project.
|
# General information about the project.
|
||||||
project = 'nix-cookbook'
|
project = 'nix.dev'
|
||||||
copyright = u'2016, Domen Kožar'
|
copyright = u'2016, Domen Kožar'
|
||||||
author = u'Domen Kožar'
|
author = u'Domen Kožar'
|
||||||
|
|
||||||
|
@ -113,13 +114,7 @@ todo_include_todos = True
|
||||||
|
|
||||||
# -- Options for HTML output ----------------------------------------------
|
# -- Options for HTML output ----------------------------------------------
|
||||||
|
|
||||||
# The theme to use for HTML and HTML Help pages. See the documentation for
|
html_theme = "flask"
|
||||||
# a list of builtin themes.
|
|
||||||
import sphinx_rtd_theme
|
|
||||||
|
|
||||||
html_theme = "sphinx_rtd_theme"
|
|
||||||
|
|
||||||
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
|
|
||||||
|
|
||||||
# Theme options are theme-specific and customize the look and feel of a theme
|
# 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
|
# further. For a list of options available for each theme, see the
|
||||||
|
@ -213,7 +208,7 @@ html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
|
||||||
#html_search_scorer = 'scorer.js'
|
#html_search_scorer = 'scorer.js'
|
||||||
|
|
||||||
# Output file base name for HTML help builder.
|
# Output file base name for HTML help builder.
|
||||||
htmlhelp_basename = 'nixpkgs-cookbookdoc'
|
#htmlhelp_basename = 'nixpkgs-'
|
||||||
|
|
||||||
# -- Options for LaTeX output ---------------------------------------------
|
# -- Options for LaTeX output ---------------------------------------------
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue