Silver Bullet

Sphinx-powered note-taking system of SilverRainZ.

There are some articles describes the architecture of this note-taking system.

Browse

Visit https://silverrainz.me/ (hosted by Github Pages).

For visitors in China, there is a Gitee Pages mirror: https://silverrainz.gitee.io/

位于**的访客可以访问 Gitee 镜像： https://silverrainz.gitee.io/

Dependencies

You MUST have following programs installed:

Git
GNU make
Python>=3.9
Sphinx>5

Install python package dependencies by the following commmands:

pip3 install --user -r requirements.txt

I developed series of sphinx extensions for my note-taking system. You can found them in the requirements.txt:

The following programs are OPTIONAL if you don’t need to build various contents embedded in the documentation:

Lilypond
Timidity++
FFmpeg
ImageMagick
Graphviz
PlantUML

Build

Firstly clone this repository (The repository is quite big, clone with --depth=1 if you dont want to make any changes):

git clone https://github.com/SilverRainZ/bullet.git

Ask sphinx to build HTML documentation:

make

Root page of the HTML documentation can be found at _build/html/index.html.

LICENSE

The contents of this repository/documentation are all published under Attribution-ShareAlike (CC BY-SA) agreement. For more details, please refer to: LICENSE.

Ability to run text builder successfully

make text returns:

...
/Users/bytedance/Documents/bullet/notes/zxsys/way-to-artist/find-yourself.rst:: WARNING: image file not readable: notes/zxsys/way-to-artist/_any/_images/IMG_0098.jpg
/Users/bytedance/Documents/bullet/notes/zxsys/way-to-artist/find-yourself.rst:: WARNING: image file not readable: notes/zxsys/way-to-artist/_any/_images/IMG_20210408_230947__01.jpg
/Users/bytedance/Documents/bullet/notes/zxsys/way-to-artist/find-yourself.rst:: WARNING: image file not readable: notes/zxsys/way-to-artist/_any/_images/IMG_20210408_231027__01.jpg
/Users/bytedance/Documents/bullet/notes/zxsys/way-to-artist/find-yourself.rst:: WARNING: image file not readable: notes/zxsys/way-to-artist/_any/_images/IMG_20210408_231154__01.jpg
/Users/bytedance/Documents/bullet/notes/zxsys/way-to-artist/find-yourself.rst:: WARNING: image file not readable: notes/zxsys/way-to-artist/_any/_images/IMG_20210408_231214__01.jpg
/Users/bytedance/Documents/bullet/notes/zxsys/way-to-artist/find-yourself.rst:: WARNING: image file not readable: notes/zxsys/way-to-artist/_any/_images/IMG_20210408_231237__01__01.jpg
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
Building prefix dict from the default dictionary ...
Dumping model to file cache /var/folders/x2/qx6m4lz12hq87zcf853whhx80000gp/T/jieba.cache
Loading model cost 0.674 seconds.
Prefix dict has been built successfully.
purging orphan document(s)... [100%] 404
dumping dirty document(s)... [100%] 404

Exception occurred:
  File "/Users/bytedance/Library/Python/3.9/lib/python/site-packages/sphinx/registry.py", line 347, in create_translator
    setattr(translator, 'visit_' + name, MethodType(visit, translator))
TypeError: first argument must be callable
The full traceback has been saved in /var/folders/x2/qx6m4lz12hq87zcf853whhx80000gp/T/sphinx-err-02_kka25.log, if you want to report the issue to the developers.
Please also report this if it was a user error, so that a better error message can be provided next time.
A bug report can be filed in the tracker at <https://github.com/sphinx-doc/sphinx/issues>. Thanks!
make: *** [text] Error 2

silverrainz / silverrainz.github.io Goto Github PK

silverrainz.github.io's Introduction

Silver Bullet

Browse

Dependencies

Build

LICENSE

silverrainz.github.io's People

Stargazers

Watchers

Forkers

silverrainz.github.io's Issues

Recommend Projects

Recommend Topics

Recommend Org