Clean up documentation a little and point to new doc location

This commit is contained in:
Veronica Berglyd Olsen
2023-04-04 18:35:39 +02:00
parent 42dd7ce0d7
commit 54806ba753
7 changed files with 10 additions and 57 deletions
Binary file not shown.

After

Width:  |  Height:  |  Size: 28 KiB

+2 -27
View File
@@ -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"]
Binary file not shown.

Before

Width:  |  Height:  |  Size: 13 KiB

+6 -12
View File
@@ -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
+1 -1
View File
@@ -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.
+1 -1
View File
@@ -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