-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
edc7eb3
commit 87427a6
Showing
32 changed files
with
16,534 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
# General | ||
# ------------------------------------------------------------------------------ | ||
USE_DOCKER=yes | ||
IPYTHONDIR=/app/.ipython | ||
# Redis | ||
# ------------------------------------------------------------------------------ | ||
REDIS_URL=redis://redis:6379/0 | ||
|
||
# Celery | ||
# ------------------------------------------------------------------------------ | ||
|
||
# Flower | ||
CELERY_FLOWER_USER=PhFRdLexbrsBvrrbSXxjcMMOcVOavCrZ | ||
CELERY_FLOWER_PASSWORD=QgScyefPrYhHgO6onW61u0nazc5xdBuP4sM7jMRrBBFuA2RjsFhZLp7xbVYZbrwR |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
# PostgreSQL | ||
# ------------------------------------------------------------------------------ | ||
POSTGRES_HOST=postgres | ||
POSTGRES_PORT=5432 | ||
POSTGRES_DB=core | ||
POSTGRES_USER=GVRFlLmcCNfGLhsFvSnCioYOPJPYpyfj | ||
POSTGRES_PASSWORD=BQ4hSUL4rdj5WZLdR8ilDLRQMvCtzo0caMaXDO0olGsmycQjlcZlTVK9DepZR8kk |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
# Sphinx build info version 1 | ||
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. | ||
config: 120bf43988b4b4c7515fe9e6df6b85cb | ||
tags: 645f666f9bcd5a90fca523b33c5a78b7 |
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
How To - Project Documentation | ||
====================================================================== | ||
|
||
Get Started | ||
---------------------------------------------------------------------- | ||
|
||
Documentation can be written as rst files in `core/docs`. | ||
|
||
|
||
To build and serve docs, use the commands:: | ||
docker-compose -f local.yml up docs | ||
|
||
|
||
|
||
Changes to files in `docs/_source` will be picked up and reloaded automatically. | ||
|
||
`Sphinx <https://www.sphinx-doc.org/>`_ is the tool used to build documentation. | ||
|
||
Docstrings to Documentation | ||
---------------------------------------------------------------------- | ||
|
||
The sphinx extension `apidoc <https://www.sphinx-doc.org/en/master/man/sphinx-apidoc.html/>`_ is used to automatically document code using signatures and docstrings. | ||
|
||
Numpy or Google style docstrings will be picked up from project files and availble for documentation. See the `Napoleon <https://sphinxcontrib-napoleon.readthedocs.io/en/latest/>`_ extension for details. | ||
|
||
For an in-use example, see the `page source <_sources/users.rst.txt>`_ for :ref:`users`. | ||
|
||
To compile all docstrings automatically into documentation source files, use the command: | ||
:: | ||
make apidocs | ||
|
||
|
||
This can be done in the docker container: | ||
:: | ||
|
||
docker run --rm docs make apidocs |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
.. SciELO Content Manager documentation master file, created by | ||
sphinx-quickstart. | ||
You can adapt this file completely to your liking, but it should at least | ||
contain the root `toctree` directive. | ||
Welcome to SciELO Content Manager 's documentation! | ||
====================================================================== | ||
|
||
.. toctree:: | ||
:maxdepth: 2 | ||
:caption: Contents: | ||
|
||
howto | ||
users | ||
|
||
|
||
|
||
Indices and tables | ||
================== | ||
|
||
* :ref:`genindex` | ||
* :ref:`modindex` | ||
* :ref:`search` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
.. _users: | ||
|
||
Users | ||
====================================================================== | ||
|
||
Starting a new project, it’s highly recommended to set up a custom user model, | ||
even if the default User model is sufficient for you. | ||
|
||
This model behaves identically to the default user model, | ||
but you’ll be able to customize it in the future if the need arises. | ||
|
||
.. automodule:: core.users.models | ||
:members: | ||
:noindex: | ||
|
Oops, something went wrong.