File: README.md

package info (click to toggle)
python-sphinx-code-include 1.1.1-4
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 1,272 kB
  • sloc: javascript: 8,765; python: 1,270; makefile: 23
file content (23 lines) | stat: -rw-r--r-- 548 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
What Is This Project Used For?
==============================

`sphinx-code-include` supports targetting objects in other projects. This
project is used to test that intersphinx support works correctly.


How To Build
============

```bash
PYTHONPATH=$PWD:python:$PYTHONPATH sphinx-build documentation/source documentation/build
```


Add To Unittests
================

Once the documentation is built, copy it to `sphinx-code-include` with this command:

```bash
rm -rf ../tests/fake_project && cp -r documentation/build ../tests/fake_project
```