Restructure document

- Ref changelog in document - Rename migration to upgrade - Drop important changes - Update current development environmenT
attakei · Nov 20, 2021 · a6c3ee9 · a6c3ee9
1 parent fb2301d
commit a6c3ee9
Show file tree

Hide file tree

Showing 5 changed files with 21 additions and 35 deletions.
diff --git a/CHANGES.rst b/CHANGES.rst
@@ -1,6 +1,6 @@
-===========
-Change logs
-===========
+=========
+Changelog
+=========
 
 ver 1.4.2
 =========

diff --git a/doc/changes.rst b/doc/changes.rst
@@ -0,0 +1,3 @@
+:tocdepth: 1
+
+.. include:: ../CHANGES.rst
diff --git a/doc/index.rst b/doc/index.rst
@@ -14,24 +14,6 @@ Basic Features
 * Syntax highlight for Reveal.js (not used pygments)
 * Customize slides and sections by conf.py or source reST
 
-Important changes
-=================
-
-1.2.x => 1.3
-------------
-
-Support kebab-case name for all directives.
-You can use ``revealjs-section`` instead of ``revealjs_section``.
-I am planning to remove snake-case directives, but not soon
-(least, keeping until version 2.x).
-
-In document and demo, use kebab-case directive.
-
-0.x => 1.x
-----------
-
-In update from 0.x to 1.x, it has breaking changes. See :doc:`./migrations`.
-
 Demo
 ====
 
@@ -50,25 +32,26 @@ Demo
     .. figure:: _static/screenshot-revealjs.png
         :alt: Screenshot of Reveal.js slide
 
+Concept and motivation
+======================
+
+Goal of this library is to provide presentation platform
+for self-branding of engineer using Sphinx.
+Using static site hosting service, you can show own presentations to anyone.
+
+Core motivation is that I want to play presentation by this library.
+
 Contents
 ========
 
 .. toctree::
    :maxdepth: 2
 
    setup
-   migrations
+   upgrade
    configurations
    directives
-
-Concept and motivation
-======================
-
-Goal of this library is to provide presentation platform
-for self-branding of engineer using Sphinx.
-Using static site hosting service, you can show own presentations to anyone.
-
-Core motivation is that I want to play presentation by this library.
+   changes
 
 Licenses
 ========

diff --git a/doc/setup.rst b/doc/setup.rst
@@ -11,7 +11,7 @@ Current development environment
 -------------------------------
 
 * Python: ``3.9``
-* Sphinx: ``2.4.4``
+* Sphinx: ``3.5.4``
 
 
 Installation

diff --git a/doc/migrations.rst → doc/upgrade.rst b/doc/migrations.rst → doc/upgrade.rst
@@ -1,9 +1,9 @@
 ===============
-Migration guide
+Upgrading guide
 ===============
 
-To 0.x -> 1.x
-=============
+To 1.x from 0.x
+===============
 
 From version 1.x, this bundle Reveal.js 4.x, and implement for it.
 Due it, documentations for old version does not work to build correctly.