Unverified Commit eeefb875 authored by Kiryuu's avatar Kiryuu
Browse files

Initial commit

parents
# No buildfile
build
\ No newline at end of file
# Minimal makefile for Sphinx documentation
#
# You can set these variables from the command line, and also
# from the environment for the first two.
SPHINXOPTS ?=
SPHINXBUILD ?= sphinx-build
SOURCEDIR = source
BUILDDIR = build
# Put it first so that "make" without argument is like "make help".
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
.PHONY: help Makefile
# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
@ECHO OFF
pushd %~dp0
REM Command file for Sphinx documentation
if "%SPHINXBUILD%" == "" (
set SPHINXBUILD=sphinx-build
)
set SOURCEDIR=source
set BUILDDIR=build
if "%1" == "" goto help
%SPHINXBUILD% >NUL 2>NUL
if errorlevel 9009 (
echo.
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
echo.installed, then set the SPHINXBUILD environment variable to point
echo.to the full path of the 'sphinx-build' executable. Alternatively you
echo.may add the Sphinx directory to PATH.
echo.
echo.If you don't have Sphinx installed, grab it from
echo.http://sphinx-doc.org/
exit /b 1
)
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
goto end
:help
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
:end
popd
# Configuration file for the Sphinx documentation builder.
#
# This file only contains a selection of the most common options. For a full
# list see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html
# -- Path setup --------------------------------------------------------------
# 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.
#
# import os
# import sys
# sys.path.insert(0, os.path.abspath('.'))
import sphinx_rtd_theme
# -- Project information -----------------------------------------------------
project = 'Nekoshima'
copyright = '2020, Kiryuu Sakuya'
author = 'Kiryuu Sakuya'
# The full version, including alpha/beta/rc tags
release = 'Developer Release v1'
# -- General configuration ---------------------------------------------------
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
"sphinx_rtd_theme"
]
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language = 'en'
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = []
# -- Options for HTML output -------------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = 'sphinx_rtd_theme'
# 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']
\ No newline at end of file
Contribute to Nekoshima
=======================
Thank you for considering contributing to Nekoshima. Awesome! This document will help you get started.
Talk to us!
-----------
You can chat with us on `element <https://chat.251.sh>`_.
Non-code contributions
----------------------
Provide feedback
^^^^^^^^^^^^^^^^
Is there anything that bothers you about Nekoshima? Did you experience an issue while installing it or using it? Would you like to see it evolve to match your requirements? Let us know by talk to us, or open a issue.
Translate
^^^^^^^^^
Translating the entire documentation is a daunting task, but you can contribute as much as you like, even a single file.
Sponsor
^^^^^^^
:3
Developers
----------
Cool!
\ No newline at end of file
Features
========
A social platform
-----------------
Nekoshima aimed at give power back to the creators. It is suited for communities and was designed to socialize around creators and fans. Creators can interact with fans directly, fans also can discover other new content. While some of these features are not currently implemented,
our roadmap includes:
- Song selling
- Live broadcasts
- Recommendations
Distributed storage
-------------------
Nekoshima support IPFS. Instance owner can choose where the audio will be hosted from.
Structure
---------
This is a modular product, so it's possbile to deploy only a single component from the system.
Federation
----------
Nekoshima makes use of the `ActivityPub protocol <https://www.w3.org/TR/activitypub/>`_ to share activities
across the `fediverse <https://en.wikipedia.org/wiki/Fediverse>`_. In particular, content uploaded in :doc:`channels <users/channels>`
is shared publicly with other Nekoshima users as well as other ActivityPub enabled applications such as Reel2Bits
and Mastodon, and can be followed using each application's interface. Content shared in users' libraries can be
followed by users of other pods.
.. Nekoshima documentation master file, created by
sphinx-quickstart on Sun Nov 8 12:22:07 2020.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to Nekoshima's documentation!
=====================================
Nekoshima is a self-hosted, modern free and open-source music server, heavily inspired by Soundcloud & Bandcamp.
.. warning:: Nekoshima is still in development.
.. toctree::
:maxdepth: 2
features
users/index
contribute
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
User Documentation
==================
This documentation is targeted at Nekoshima users.
Getting Started
---------------
.. toctree::
:maxdepth: 2
create
tagging
upload
editing
Using Nekoshima
---------------
.. toctree::
:maxdepth: 2
account
Troubleshooting Issues
----------------------
.. toctree::
:maxdepth: 2
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment