Skip to content
This repository was archived by the owner on Mar 29, 2024. It is now read-only.

Move to readthedocs #103

Merged
merged 1 commit into from
Feb 27, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 2 additions & 3 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ configure.ac
install-sh
libtool
ltmain.sh
Makefile
/Makefile
Makefile.fragments
Makefile.global
Makefile.objects
Expand All @@ -42,6 +42,5 @@ tmp-php.ini
/conftest*

/*.tgz
.virtualenv

_book/
node_modules/
17 changes: 12 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ PHP extension for V8 JavaScript engine

[![Build Status](https://api.travis-ci.org/pinepain/php-v8.svg?branch=master)](https://travis-ci.org/pinepain/php-v8)
[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/pinepain/php-v8/master/LICENSE)
[![Docs](https://readthedocs.org/projects/php-v8/badge/)](https://php-v8.readthedocs.io)


**This extension requires PHP >= 7.1**. Last version that supports PHP 7.0 is v0.1.9.

Expand All @@ -13,7 +15,7 @@ PHP extension for V8 JavaScript engine
Maintaining this project takes significant amount of time and efforts.
If you like my work and want to show your appreciation, please consider supporting me at https://www.patreon.com/pinepain.

Work in progress documentation could be found at https://pinepain.gitbooks.io/php-v8/content/. You can also use tests and
Work in progress documentation could be found at https://php-v8.readthedocs.io. You can also use tests and
stubs as reference.

## Why (aka Rationale)
Expand Down Expand Up @@ -181,11 +183,16 @@ Now you can build php-v8 as usual with `phpize && ./configure && make`. Don't fo

### Docs

To start writing docs you will need to get [GitBook](https://gitbook.com), just run `npm install gitbook-cli -g` and
then `gitbook serve` in project rood directory to live preview docs or `gitbook build` to build static website. See
[Setup and Installation of GitBook](https://toolchain.gitbook.com/setup.html) official GitBook manual for more;
We use [Sphinx](http://www.sphinx-doc.org/en/master/) to buld docs and [Read The Docs](https://readthedocs.org/) to host
it.

To rebuild docs locally run in a project root:

virtualenv -p `which python` .virtualenv
source .virtualenv/bin/activate
cd docs
make html

You may find [GitBook Editor](https://www.gitbook.com/editor) useful for docs writing and editing.

## Credits

Expand Down
1 change: 1 addition & 0 deletions docs/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
_build
20 changes: 20 additions & 0 deletions docs/Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Minimal makefile for Sphinx documentation
#

# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
SPHINXPROJ = php-v8
SOURCEDIR = .
BUILDDIR = _build

# Put it first so that "make" without argument is like "make help".
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

.PHONY: help Makefile

# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
57 changes: 0 additions & 57 deletions docs/README.md

This file was deleted.

11 changes: 0 additions & 11 deletions docs/SUMMARY.md

This file was deleted.

190 changes: 190 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,190 @@
# -*- coding: utf-8 -*-
#
# Configuration file for the Sphinx documentation builder.
#
# This file does only contain a selection of the most common options. For a
# full list see the documentation:
# http://www.sphinx-doc.org/en/stable/config

# -- Path setup --------------------------------------------------------------

# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#
# import os
# import sys
# sys.path.insert(0, os.path.abspath('.'))

# import sys, os
# from sphinx.highlighting import lexers
# from pygments.lexers.web import PhpLexer
#
#
# lexers['php'] = PhpLexer(startinline=True, linenos=1)
# lexers['php-annotations'] = PhpLexer(startinline=True, linenos=1)
# primary_domain = 'php'


import sys
import os
import shlex
from sphinx.highlighting import lexers
from pygments.lexers.web import PhpLexer

lexers['php'] = PhpLexer(startinline=True, linenos=1)

primary_domain = 'php'
highlight_language = 'php'

# -- Project information -----------------------------------------------------

project = u'php-v8'
copyright = u'2018, Bogdan Padalko'
author = u'Bogdan Padalko'

# The short X.Y version
version = u''
# The full version, including alpha/beta/rc tags
release = u''


# -- General configuration ---------------------------------------------------

# If your documentation needs a minimal Sphinx version, state it here.
#
# needs_sphinx = '1.0'

# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
'sphinx.ext.doctest',
'sphinx.ext.todo',
'sphinx.ext.coverage',
'sphinxcontrib.phpdomain'
#'sphinxcontrib.spelling'
]

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']

# The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string:
#
# source_suffix = ['.rst', '.md']
source_suffix = '.rst'

# The master toctree document.
master_doc = 'index'

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language = None

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path .
exclude_patterns = [u'_build', 'Thumbs.db', '.DS_Store']

# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'


# -- Options for HTML output -------------------------------------------------

# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = 'sphinx_rtd_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
# documentation.
#
# html_theme_options = {}

# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']

# Custom sidebar templates, must be a dictionary that maps document names
# to template names.
#
# The default sidebars (for documents that don't match any pattern) are
# defined by theme itself. Builtin themes are using these templates by
# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
# 'searchbox.html']``.
#
# html_sidebars = {}


# -- Options for HTMLHelp output ---------------------------------------------

# Output file base name for HTML help builder.
htmlhelp_basename = 'php-v8doc'


# -- Options for LaTeX output ------------------------------------------------

latex_elements = {
# The paper size ('letterpaper' or 'a4paper').
#
# 'papersize': 'letterpaper',

# The font size ('10pt', '11pt' or '12pt').
#
# 'pointsize': '10pt',

# Additional stuff for the LaTeX preamble.
#
# 'preamble': '',

# Latex figure (float) alignment
#
# 'figure_align': 'htbp',
}

# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
(master_doc, 'php-v8.tex', u'php-v8 Documentation',
u'Bogdan Padalko', 'manual'),
]


# -- Options for manual page output ------------------------------------------

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
(master_doc, 'php-v8', u'php-v8 Documentation',
[author], 1)
]


# -- Options for Texinfo output ----------------------------------------------

# Grouping the document tree into Texinfo files. List of tuples
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
(master_doc, 'php-v8', u'php-v8 Documentation',
author, 'php-v8', 'One line description of project.',
'Miscellaneous'),
]


# -- Extension configuration -------------------------------------------------

spelling_word_list_filename='spelling_wordlist.txt'

# -- Options for todo extension ----------------------------------------------

# If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = True
12 changes: 12 additions & 0 deletions docs/development/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
===============
Release process
===============

Here you can find basics to the release process


.. toctree::
:maxdepth: 3

release-php-v8
release-libv8
Loading