dblog's Introduction

README

This is a project template for getting started with your developer blog. See Start your own developer blog for an introducton.

Installation:

Make a clone of this project into some directory of your choice. For example:
```
$ cd ~/projects
$ git clone https://github.com/lsaffre/dblog.git blog
```
This will create a directory ~/projects/blog with all necessary files. On the Linux command line ~ is shorthand for your home directory.

Note that we explicitly specified your local project name "blog" as an argument to the git command. This name is not visible to the outside. Without that argument, git would use dblog as local project name, which would be suboptimal since "dblog" is just the name of this template project. See Setting up your work environment for more details.

Activate your virtualenv and install the atelier Python package:
```
$ pip install atelier
```
Edit the following files and replace at least "John Doe" by your name:
- ~/projects/blog/docs/conf.py
- ~/projects/blog/docs/index.rst

Create a file named .invoke.py in your home directory with the following content (replacing john by your local username, johndoe by the name of your SSH account):

blog_root = '/home/john/projects/blog/docs'
blogref_url = 'http://johndoe.lino-framework.org'
docs_rsync_dest = '[email protected]:~/public_html/%s'
editor_command = 'vim'
# editor_command = 'emacsclient -n'
# editor_command = '/path/to/pycharm/bin/pycharm.sh'

To start blogging:

$ cd ~/projects/blog
$ inv blog

To build your docs locally:

$ inv bd

To see your built doctree:

$ firefox docs/.build/index.html

To publish your docs:

$ inv pd

Before this last step can work, you need to configure where your blog is to be published.

You need an SSH account on some public server. For example [email protected]. And that web server must be configured to serve /home/john/public_html/blog_docs to the outside. For example if you want your blog to be visible under http://www.doe.org you point your browser's "/" location to public_html/blog_docs.

As a Lino contributor you'll get a free account on lino-framework.org, just ask for it.

dblog's People

Contributors

Watchers

dblog's Issues

SphinxWarning: autodoc_default_flags is now deprecated, treated as error

Dear @lsaffre ,

I followed your tutorial for making my own blog based on the template you have (dblog). Everything seems to work fine until I execute inv bd.

The command starts to execute and it crashes with the following output:
"""
Invoking Sphinx in directory /home/localaccount/lab_8/blog/docs...
Invoke sphinx-build -b html -T -W . /home/localaccount/lab_8/blog/docs/.build
Running Sphinx v1.8.0
loading translations [en]... done

Traceback (most recent call last):
File "/home/localaccount/lab_8/venv8/local/lib/python2.7/site-packages/sphinx/cmd/build.py", line 303, in build_main
args.tags, args.verbosity, args.jobs, args.keep_going)
File "/home/localaccount/lab_8/venv8/local/lib/python2.7/site-packages/sphinx/application.py", line 251, in init
self.emit('config-inited', self.config)
File "/home/localaccount/lab_8/venv8/local/lib/python2.7/site-packages/sphinx/application.py", line 510, in emit
return self.events.emit(event, self, *args)
File "/home/localaccount/lab_8/venv8/local/lib/python2.7/site-packages/sphinx/events.py", line 80, in emit
results.append(callback(*args))
File "/home/localaccount/lab_8/venv8/local/lib/python2.7/site-packages/sphinx/ext/autodoc/init.py", line 1565, in merge_autodoc_default_flags
logger.warning(__('autodoc_default_flags is now deprecated. '
File "/usr/lib/python2.7/logging/init.py", line 1456, in warning
self.logger.warning(msg, *args, **kwargs)
File "/usr/lib/python2.7/logging/init.py", line 1179, in warning
self._log(WARNING, msg, args, **kwargs)
File "/usr/lib/python2.7/logging/init.py", line 1286, in _log
self.handle(record)
File "/usr/lib/python2.7/logging/init.py", line 1296, in handle
self.callHandlers(record)
File "/usr/lib/python2.7/logging/init.py", line 1336, in callHandlers
hdlr.handle(record)
File "/usr/lib/python2.7/logging/init.py", line 755, in handle
rv = self.filter(record)
File "/usr/lib/python2.7/logging/init.py", line 617, in filter
if not f.filter(record):
File "/home/localaccount/lab_8/venv8/local/lib/python2.7/site-packages/sphinx/util/logging.py", line 412, in filter
raise SphinxWarning(message)
SphinxWarning: autodoc_default_flags is now deprecated. Please use autodoc_default_options instead.

Warning, treated as error:
autodoc_default_flags is now deprecated. Please use autodoc_default_options instead.
"""

"localaccount" is an alias for my local user account and not a typo.

My venv has these versions installed:

python 2.7.13
atelier 1.1.8
Sphinx 1.8.0

Btw, did not spot a "requirements.txt" so I was not sure if had the versions correctly.

I also noticed by some brief research on the error that similar sphinx-related issues were reported (in different context) in the past few days.

Thank you in advance.

Recommend Projects

lsaffre / dblog Goto Github PK

dblog's Introduction

README

dblog's People

Contributors

Watchers

Forkers

dblog's Issues

SphinxWarning: autodoc_default_flags is now deprecated, treated as error

Recommend Projects

React

Vue.js

Typescript

TensorFlow

Django

Laravel

D3

Recommend Topics

javascript

web

server

Machine learning

Visualization

Game

Recommend Org

Facebook

Microsoft

Google

Alibaba

D3

Tencent