bump Sphinx version; update docs.

mocobeta · Feb 23, 2022 · 7c271b6 · 7c271b6
1 parent dc7ee37
commit 7c271b6
Show file tree

Hide file tree

Showing 8 changed files with 24 additions and 53 deletions.
diff --git a/docs/build_docs.sh b/docs/build_docs.sh
@@ -8,6 +8,6 @@ python -m venv .venv
 . .venv/bin/activate
 pip install -r requirements-docs.txt
 
-cd ${BASEDIR}/api && make html
-cd ${BASEDIR}/ja && make html
-cd ${BASEDIR}/en && make html
+cd ${BASEDIR}/api && make clean && make html
+cd ${BASEDIR}/ja && make clean && make html
+cd ${BASEDIR}/en && make clean && make html
diff --git a/docs/en/conf.py b/docs/en/conf.py
@@ -294,4 +294,4 @@
 
 
 def setup(app):
-    app.add_stylesheet('custom.css')
+    app.add_css_file('custom.css')
diff --git a/docs/en/index.rst b/docs/en/index.rst
@@ -19,12 +19,10 @@ Welcome to janome's documentation! (English)
 What's Janome?
 --------------
 
-.. figure:: ../img/janome_small.jpg
+.. image:: ../img/janome_small.jpg
   :scale: 20
   :align: right
 
-  Illustration by `janome <https://janomeekaki.wixsite.com/janome>`_. All rights reserved.
-
 Janome (蛇の目; ◉) is a Japanese morphological analysis engine (or tokenizer, pos-tagger) written in pure Python including the built-in dictionary and the language model.
 
 We aim to build a library which is easy to install and provides concise, well-designed APIs for various python applications.
@@ -370,7 +368,10 @@ Use ``-e sjis`` option if the output is garbled.
 Visualizing lattice graph
 ^^^^^^^^^^^^^^^^^^^^^^^^^
 
-.. note:: You need Graphviz to use this functionality. Please install Graphviz from `here <https://graphviz.gitlab.io/download/>`_.
+.. note:: 
+
+  You need Graphviz to use this functionality. Please install Graphviz from `here <https://graphviz.gitlab.io/download/>`_.
+
 
 If given ``-g`` option, janome command outputs the visualized lattice image to the current directory after analyzing the text. Default output format is PNG.
 

diff --git a/docs/ja/conf.py b/docs/ja/conf.py
@@ -293,4 +293,4 @@
 
 
 def setup(app):
-    app.add_stylesheet('custom.css')
+    app.add_css_file('custom.css')
diff --git a/docs/ja/index.rst b/docs/ja/index.rst
@@ -18,12 +18,10 @@ Welcome to janome's documentation! (Japanese)
 Janome とは
 -----------
 
-.. figure:: ../img/janome_small.jpg
+.. image:: ../img/janome_small.jpg
   :scale: 20
   :align: right
 
-  Illustration by `janome <https://janomeekaki.wixsite.com/janome>`_. All rights reserved.
-
 Janome (蛇の目; ◉) は，Pure Python で書かれた，辞書内包の形態素解析器です。
 
 依存ライブラリなしで簡単にインストールでき，アプリケーションに組み込みやすいシンプルな API を備える形態素解析ライブラリを目指しています。

diff --git a/docs/requirements-docs.txt b/docs/requirements-docs.txt
@@ -1,2 +1,2 @@
-Sphinx==3.2.1
+Sphinx==4.4.0
 sphinxcontrib-github-ribbon==0.9.0
diff --git a/release-memo.md b/release-memo.md
@@ -6,43 +6,7 @@
 $ python setup.py test
 ```
 
-2. Update CHANGES.txt and documentation.
-
-3. Build the release candidates and upload them to TestPyPI.
-
-https://packaging.python.org/guides/using-testpypi/
-
-```
-$ cat janome/version.py
-JANOME_VERSION='x.x.xrc1'
-$ rm dist/*
-$ python setup.py sdist
-$ python setup.py bdist_wheel --universal
-```
-
-```
-$ twine upload --repository-url https://test.pypi.org/legacy/ dist/*
-```
-
-4. Confirm the release candidate works correctly with Python 3.
-
-```
-$ pip install -i https://test.pypi.org/simple/ Janome==x.x.xrc1
-$ pip freeze
-Janome==x.x.xrc1
-$ echo "リリースするぞ！" | janome
-```
-
-5. Create a tag for the release.
-
-```
-$ cat janome/version.py
-JANOME_VERSION='x.x.x'
-$ git tag x.x.x
-$ git push --tags
-```
-
-6. Build the release modules and upload them to PyPI.
+2. Build the release modules and upload them to PyPI.
 
 ```
 $ rm dist/*
@@ -54,7 +18,7 @@ $ python setup.py bdist_wheel --universal
 $ twine upload dist/*
 ```
 
-7. Publish documentation.
+3. Publish documentation.
 
 Generate documentation.
 
@@ -68,5 +32,12 @@ Publish to web site.
 $ ./docs/upload_docs.sh $DOCS_ROOT_PATH
 ```
 
+4. Create a tag for the release.
+
+```
+$ git tag x.x.x
+$ git push --tags
+```
+
 Well done!
 
diff --git a/setup.py b/setup.py
@@ -29,9 +29,10 @@
     "Development Status :: 4 - Beta",
     "License :: OSI Approved :: Apache Software License",
     "Natural Language :: Japanese",
-    "Programming Language :: Python :: 3.6",
     "Programming Language :: Python :: 3.7",
-    "Programming Language :: Python :: 3.8"
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10"
 ]
 
 setup(
Original file line number	Diff line number	Diff line change
Expand Up		@@ -294,4 +294,4 @@


		def setup(app):
		app.add_stylesheet('custom.css')
		app.add_css_file('custom.css')
Original file line number	Diff line number	Diff line change
Expand Up		@@ -293,4 +293,4 @@


		def setup(app):
		app.add_stylesheet('custom.css')
		app.add_css_file('custom.css')