diff --git a/.readthedocs.yml b/.readthedocs.yml index 4e534f30..ebd38255 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -1,24 +1,8 @@ # Read the Docs configuration file # See https://docs.readthedocs.io/en/stable/config-file/v2.html for details - -# Required version: 2 - -# Build documentation in the docs/ directory with Sphinx sphinx: configuration: docs/source/conf.py - -# Build documentation with MkDocs -#mkdocs: -# configuration: mkdocs.yml - -# Optionally build your docs in additional formats such as PDF -formats: - - htmlzip - - epub - - pdf - -# Optionally set the version of Python and requirements required to build your docs python: install: - requirements: docs/source/requirements.txt diff --git a/docs/source/_static/novelwriter-pdf.png b/docs/source/_static/novelwriter-pdf.png new file mode 100644 index 00000000..6261b1ee Binary files /dev/null and b/docs/source/_static/novelwriter-pdf.png differ diff --git a/docs/source/conf.py b/docs/source/conf.py index 03e1d9d7..20a8c2ab 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -83,37 +83,12 @@ latex_elements = { ), "figure_align": "htbp", } +latex_logo = "_static/novelwriter-pdf.png" # 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, "manual.tex", "novelWriter Documentation", + master_doc, "manual.tex", "User Guide", author, "manual" )] - -# -- Options for Man Page Output --------------------------------------------- - -# One entry per manual page. List of tuples -# (source start file, name, description, authors, manual section). -man_pages = [( - master_doc, "novelwriter", "novelWriter 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, "novelWriter", "novelWriter Documentation", author, - "novelWriter", "Markdown-like editor for novels.", "Miscellaneous" -)] - -# -- Options for EPub Output ------------------------------------------------- - -# Bibliographic Dublin Core info. -epub_title = project - -# A list of files that should not be packed into the epub file. -epub_exclude_files = ["search.html"] diff --git a/docs/source/images/novelwriter_logo.png b/docs/source/images/novelwriter_logo.png deleted file mode 100644 index c4161426..00000000 Binary files a/docs/source/images/novelwriter_logo.png and /dev/null differ diff --git a/docs/source/index.rst b/docs/source/index.rst index c9ba0aa9..c7c1180f 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -1,15 +1,9 @@ -############################# -Documentation for novelWriter -############################# +###################### +novelWriter User Guide +###################### -.. image:: images/novelwriter_logo.png - :class: dark-light - :align: right - :width: 64 - -| **For Release:** |release| -| **Last Updated:** |today| -| +| **Release Version:** |release| +| **Updated:** |today| novelWriter is an open source plain text editor designed for writing novels assembled from many smaller text documents. It uses a minimal formatting syntax inspired by Markdown, and adds a meta @@ -40,7 +34,7 @@ the pip tool. See :ref:`a_started` for more details. **Useful Links** * Website: https://novelwriter.io -* Documentation: https://novelwriter.readthedocs.io +* Documentation: https://docs.novelwriter.io * Internationalisation: https://crowdin.com/project/novelwriter * Source Code: https://github.com/vkbo/novelWriter * Source Releases: https://github.com/vkbo/novelWriter/releases diff --git a/docs/source/tech_storage.rst b/docs/source/tech_storage.rst index 1affa04f..10eb9cc8 100644 --- a/docs/source/tech_storage.rst +++ b/docs/source/tech_storage.rst @@ -4,7 +4,7 @@ How Data is Stored ****************** -.. _documentation: https://novelwriter.readthedocs.io +.. _documentation: https://docs.novelwriter.io/ This section contains details of how novelWriter stores and handles the project data. diff --git a/docs/source/usage_projectformat.rst b/docs/source/usage_projectformat.rst index 22e43b69..6d357a69 100644 --- a/docs/source/usage_projectformat.rst +++ b/docs/source/usage_projectformat.rst @@ -5,7 +5,7 @@ Project Format Changes ********************** .. _File Format Spec 1.5: _static/fileformatspec15.pdf -.. _documentation: https://novelwriter.readthedocs.io +.. _documentation: https://docs.novelwriter.io/ Most of the changes to the file formats over the history of novelWriter have no impact on the user-side of things. The project files are generally updated automatically. However, some of the