From 2edc7aa5583b2d241b4f18a2b06b2dead36ea8c1 Mon Sep 17 00:00:00 2001 From: Radek Czajka Date: Wed, 21 Aug 2019 12:04:45 +0200 Subject: [PATCH] Basic updates in docs. --- doc/architecture.rst | 25 ++++--------------------- doc/conf.py | 23 ++++++++++------------- doc/installation.rst | 18 +++++------------- 3 files changed, 19 insertions(+), 47 deletions(-) diff --git a/doc/architecture.rst b/doc/architecture.rst index db5b6989d..d1985e482 100644 --- a/doc/architecture.rst +++ b/doc/architecture.rst @@ -16,7 +16,7 @@ What are ``Tags`` used for? --------------------------- Each ``Tag`` objects has a ``category`` field specyfying its meaning. -The categories are enumerated in :py:const:`catalogue.models.TAG_CATEGORIES`. +The categories are enumerated in :py:const:`catalogue.models.tag.TAG_CATEGORIES`. Tags are used for: @@ -27,7 +27,6 @@ Tags are used for: * User shelves. A User can put a ``Book`` on a shelf and add some labels by adding a number of ``set`` tags to it. A book put on a shelf without any labels has a Tag with an empty name. -* Denoting :ref:`ancestor-descendant-relations` using ``book`` tags. .. _ancestor-descendant-relations: @@ -44,22 +43,6 @@ the ``dc:relation.hasPart`` metadata field, exposed by and the order of children of one parent is expressed with the child book's ``parent`` and ``parent_number`` fields. -But aside from that, Tags are used for managing those relationships, too. - -Every ``Book`` has a matching `l-tag`. It's a ``Tag`` of category -``book`` and matching slug with an added 'l-' prefix (the prefix -is superfluous and we should remove it as some point, as it was only -needed when tag slugs had to be unique). - -The `l-tag` of a ``Book`` is used on: - -* all of the book's fragments, -* all of the book's descendants, -* all of the book's descendants' fragments. - -This is used for: - -* finding fragments of a given theme in books with a given user label, -* on a filtered book list (i.e., author's page), for eliminating - descendants, if an ancestor is already on the list, -* when calculating tag book counts, for eliminating descendants as above, +Additionally, every ``Book`` has a many-to-many relationship `ancestor`, +onnecting it to all its ancestors, with reverse relationship called +`descendant`. This relationship is rebuilt after a `Book` is published. diff --git a/doc/conf.py b/doc/conf.py index 65632658d..1e8ba2890 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -1,5 +1,3 @@ -# -*- coding: utf-8 -*- -# # Wolne Lektury documentation build configuration file, created by # sphinx-quickstart on Fri Mar 30 16:42:44 2012. # @@ -12,19 +10,18 @@ # serve to show the default. import sys, os +import django # 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. #sys.path.insert(0, os.path.abspath('.')) sys.path += [ - os.path.abspath('..'), - os.path.abspath('../apps'), - os.path.abspath('../lib'), - os.path.abspath('../lib/librarian'), + os.path.abspath('../src'), ] os.environ.setdefault("DJANGO_SETTINGS_MODULE", "wolnelektury.settings") +django.setup() @@ -50,8 +47,8 @@ source_suffix = '.rst' master_doc = 'index' # General information about the project. -project = u'Wolne Lektury' -copyright = u'2007-2014, Fundacja Nowoczesna Polska' +project = 'Wolne Lektury' +copyright = '2007-2019, Fundacja Nowoczesna Polska' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the @@ -130,7 +127,7 @@ html_theme = 'default' # 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'] +#html_static_path = ['_static'] # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, # using the given strftime format. @@ -188,8 +185,8 @@ htmlhelp_basename = 'WolneLekturydoc' # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, author, documentclass [howto/manual]). latex_documents = [ - ('index', 'WolneLektury.tex', u'Wolne Lektury Documentation', - u'Fundacja Nowoczesna Polska', 'manual'), + ('index', 'WolneLektury.tex', 'Wolne Lektury Documentation', + 'Fundacja Nowoczesna Polska', 'manual'), ] # The name of an image file (relative to this directory) to place at the top of @@ -221,8 +218,8 @@ latex_documents = [ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ - ('index', 'wolnelektury', u'Wolne Lektury Documentation', - [u'Fundacja Nowoczesna Polska'], 1) + ('index', 'wolnelektury', 'Wolne Lektury Documentation', + ['Fundacja Nowoczesna Polska'], 1) ] diff --git a/doc/installation.rst b/doc/installation.rst index 3b16bbb32..81ef4def7 100644 --- a/doc/installation.rst +++ b/doc/installation.rst @@ -5,12 +5,11 @@ Setup Requirements ------------ -* `Python 2.7 `_ -* Python requiremets: ``pip install -r requirements.txt`` +* `Python 3.5-3.7 `_ +* Python requiremets: ``pip install -r requirements/requirements.txt`` * a library for your database of choice - (see `DBs supported by Django `_) + (see `DBs supported by Django `_) * `Sass `_ >= 3.2 for parsing SCSS stylesheets -* Librarian (bundled as a git submodule, remember to ``git submodule update --init`` * Librarian has more dependencies if you want to build PDF and MOBI files, see lib/librarian/README.md * `Solr `_ server if you want to search @@ -20,7 +19,7 @@ Running ------- Set up the database with:: - ./manage.py syncdb --migrate + ./manage.py migrate Run the dev server with:: @@ -39,15 +38,8 @@ in your ``localsettings.py``:: Deployment ---------- -Setup your server in fabfile.py and do:: - fab deploy - -Initial deploy will stop and ask you to provide a localsettings.py file. -A sample localsettings.py will be put on your server, as well as -sample configuration for `Nginx `_, -`Gunicorn `_ and -`Supervisord `_. +TODO Publishing books -- 2.20.1